dep/ACE_wrappers/ace/SOCK.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    SOCK.h
   6  *
   7  *  $Id: SOCK.h 81014 2008-03-19 11:41:31Z johnnyw $
   8  *
   9  *  @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
  10  */
  11 //=============================================================================
  12
  13 #ifndef ACE_SOCK_H
  14 #define ACE_SOCK_H
  15 #include /**/ "ace/pre.h"
  16
  17 #include /**/ "ace/ACE_export.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #include "ace/Addr.h"
  24 #include "ace/IPC_SAP.h"
  25 #include "ace/OS_NS_stropts.h"
  26
  27 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 /**
  30  * @class ACE_SOCK
  31  *
  32  * @brief An abstract class that forms the basis for more specific
  33  * classes, such as ACE_SOCK_Acceptor and ACE_SOCK_Stream.
  34  * Do not instantiate this class.
  35  *
  36  * This class provides functions that are common to all of the
  37  * <ACE_SOCK_*> classes. ACE_SOCK provides the ability to get
  38  * and set socket options, get the local and remote addresses,
  39  * and open and close a socket handle.
  40  */
  41 class ACE_Export ACE_SOCK : public ACE_IPC_SAP
  42 {
  43 public:
  44
  45   /// Wrapper around the @c setsockopt system call.
  46   int set_option (int level,
  47                   int option,
  48                   void *optval,
  49                   int optlen) const;
  50
  51   /// Wrapper around the @c getsockopt system call.
  52   int get_option (int level,
  53                   int option,
  54                   void *optval,
  55                   int *optlen) const;
  56
  57   /**
  58    * Close the socket.
  59    * This method also sets the object's handle value to ACE_INVALID_HANDLE.
  60    *
  61    * @return The result of closing the socket; 0 if the handle value
  62    *         was already ACE_INVALID_HANDLE.
  63    */
  64   int close (void);
  65
  66   /// Return the local endpoint address in the referenced <ACE_Addr>.
  67   /// Returns 0 if successful, else -1.
  68   int get_local_addr (ACE_Addr &) const;
  69
  70   /**
  71    * Return the address of the remotely connected peer (if there is
  72    * one), in the referenced ACE_Addr. Returns 0 if successful, else
  73    * -1.
  74    */
  75   int get_remote_addr (ACE_Addr &) const;
  76
  77   /// Dump the state of an object.
  78   void dump (void) const;
  79
  80   /// Declare the dynamic allocation hooks.
  81   ACE_ALLOC_HOOK_DECLARE;
  82
  83   /// Wrapper around the BSD-style @c socket system call (no QoS).
  84   int open (int type,
  85             int protocol_family,
  86             int protocol,
  87             int reuse_addr);
  88
  89   /// Wrapper around the QoS-enabled @c WSASocket function.
  90   int open (int type,
  91             int protocol_family,
  92             int protocol,
  93             ACE_Protocol_Info *protocolinfo,
  94             ACE_SOCK_GROUP g,
  95             u_long flags,
  96             int reuse_addr);
  97
  98 protected:
  99
 100   /// Constructor with arguments to call the BSD-style @c socket system
 101   /// call (no QoS).
 102   ACE_SOCK (int type,
 103             int protocol_family,
 104             int protocol = 0,
 105             int reuse_addr = 0);
 106
 107   /// Constructor with arguments to call the QoS-enabled @c WSASocket
 108   /// function.
 109   ACE_SOCK (int type,
 110             int protocol_family,
 111             int protocol,
 112             ACE_Protocol_Info *protocolinfo,
 113             ACE_SOCK_GROUP g,
 114             u_long flags,
 115             int reuse_addr);
 116
 117   /// Default constructor is protected to prevent instances of this class
 118   /// from being defined.
 119   ACE_SOCK (void);
 120
 121   /// Protected destructor.
 122   /**
 123    * Not a virtual destructor.  Protected destructor to prevent
 124    * operator delete() from being called through a base class ACE_SOCK
 125    * pointer/reference.
 126    */
 127   ~ACE_SOCK (void);
 128
 129 };
 130
 131 ACE_END_VERSIONED_NAMESPACE_DECL
 132
 133 #if defined (__ACE_INLINE__)
 134 #include "ace/SOCK.inl"
 135 #endif /* __ACE_INLINE__ */
 136
 137 #include /**/ "ace/post.h"
 138 #endif /* ACE_SOCK_H */