SocketOptions.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2006-04-14 14:29:27 -0500 (Fri, 14 Apr 2006) $
 * Version:       $Revision: 18637 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_SOCKET_OPTIONS_H_
#define _VPR_SOCKET_OPTIONS_H_

#include <vpr/vprConfig.h>

#include <vpr/IO/Socket/InetAddr.h>
#include <vpr/IO/Socket/McastReq.h>
#include <vpr/Util/ReturnStatus.h>


namespace vpr
{

namespace SocketOptions
{
   enum Types
   {
      Linger,           
      ReuseAddr,        
      KeepAlive,        
      RecvBufferSize,   
      SendBufferSize,   
      IpTimeToLive,     
      IpTypeOfService,  
      AddMember,        
      DropMember,       
      Broadcast,        
      McastInterface,   
      McastTimeToLive,  
      McastLoopback,    
      NoDelay,          
      MaxSegment        
   };

   enum TypeOfService
   {
      LowDelay,     
      Throughput,   
      Reliability,  
      LowCost       
   };

   struct Linger
   {
      bool       enabled;
      vpr::Int32 seconds;
   };

   struct Data
   {
      Uint32        ip_ttl;
      TypeOfService type_of_service;
      bool          reuse_addr;
      bool          keep_alive;
      bool          no_delay;
      bool          broadcast;
      size_t        max_segment;
      size_t        recv_buffer_size;
      size_t        send_buffer_size;
      struct Linger linger;
      InetAddr      mcast_if;
      Uint8         mcast_ttl;
      Uint8         mcast_loopback;
      McastReq      mcast_add_member;
      McastReq      mcast_drop_member;
   };
}

class VPR_CLASS_API SocketOptionWrapper
{
public:
   virtual ~SocketOptionWrapper()
   {
      /* Do nothing. */ ;
   }

protected:
   virtual vpr::ReturnStatus getOption(const vpr::SocketOptions::Types option,
                                       struct vpr::SocketOptions::Data& data) const = 0;

   virtual vpr::ReturnStatus setOption(const vpr::SocketOptions::Types option,
                                       const struct vpr::SocketOptions::Data& data) = 0;
};

} // End of vpr namespace


#endif  /* _VPR_SOCKET_OPTIONS_H_ */

---