ACE/ace/SOCK_CODgram.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    SOCK_CODgram.h
   6  *
   7  *  @author Doug Schmidt
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef ACE_SOCK_CODGRAM_H
  13 #define ACE_SOCK_CODGRAM_H
  14 #include /**/ "ace/pre.h"
  15
  16 #include /**/ "ace/ACE_export.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "ace/SOCK_IO.h"
  23 #include "ace/Addr.h"
  24 #include "ace/INET_Addr.h"
  25
  26 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  27
  28 /**
  29  * @class ACE_SOCK_CODgram
  30  *
  31  * @brief Defines the member functions for the ACE_SOCK connected
  32  * datagram abstraction.
  33  */
  34 class ACE_Export ACE_SOCK_CODgram : public ACE_SOCK_IO
  35 {
  36 public:
  37   /// Default constructor.
  38   ACE_SOCK_CODgram ();
  39
  40   /**
  41    * Constructor with addresses specified. Calls open().
  42    * This constructor binds and/or connects to a specified address,
  43    * optionally binding an unused port number.
  44    *
  45    * @param remote_sap      The remote address.
  46    * @param local_sap       The local address.
  47    * @param protocol_family The protocol family for the new socket. If
  48    *                        either @p remote_sap or @p local_sap is
  49    *                        specified (i.e., not ACE_Addr::sap_any) its
  50    *                        address type is used instead of this value.
  51    *                        If both addresses are specified, their address
  52    *                        types must match. If neither address is specified,
  53    *                        the platform's default IP address type is used.
  54    * @param protocol        Protocol value for the new socket.
  55    * @param reuse_addr      Reuse the local address or not.
  56    *
  57    * There are four possible combinations of remote_sap and local_sap. The
  58    * behavior in these combinations is:
  59    *
  60    * @li <b>remote_addr == ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any:</b>
  61    *     If @p protocol_family specifies PF_INET or PF_INET6,
  62    *     bind the local address to a randomly generated port number.
  63    *
  64    * @li <b>remote_addr == ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any:</b>
  65    *     Bind the local address (used primarily by servers).
  66    *
  67    * @li <b>remote_addr != ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any:</b>
  68    *     Connect to the remote address without binding a local address
  69    *     (used primarily by clients).
  70    *
  71    * @li <b>remote_addr != ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any:</b>
  72    *     Bind to the local address and connect to the remote address.
  73    */
  74   ACE_SOCK_CODgram (const ACE_Addr &remote_sap,
  75                     const ACE_Addr &local_sap = ACE_Addr::sap_any,
  76                     int protocol_family = ACE_PROTOCOL_FAMILY_INET,
  77                     int protocol = 0,
  78                     int reuse_addr = 0);
  79
  80   /// Default dtor.
  81   ~ACE_SOCK_CODgram ();
  82
  83   // Initiate a connected dgram.
  84
  85   /**
  86    * Initiate a connected datagram socket, optionally binding an
  87    * unused port number.
  88    *
  89    * @param remote_sap      The remote address.
  90    * @param local_sap       The local address.
  91    * @param protocol_family The protocol family for the new socket. If
  92    *                        either @p remote_sap or @p local_sap is
  93    *                        specified (i.e., not ACE_Addr::sap_any) its
  94    *                        address type is used instead of this value.
  95    *                        If both addresses are specified, their address
  96    *                        types must match. If neither address is specified,
  97    *                        the platform's default IP address type is used.
  98    * @param protocol        Protocol value for the new socket.
  99    * @param reuse_addr      Reuse the local address or not.
 100    *
 101    * There are four possible combinations of remote_sap and local_sap. The
 102    * behavior in these combinations is:
 103    *
 104    * @li <b>remote_addr == ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any:</b>
 105    *     If @p protocol_family specifies PF_INET or PF_INET6,
 106    *     bind the local address to a randomly generated port number.
 107    *
 108    * @li <b>remote_addr == ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any:</b>
 109    *     Bind the local address (used primarily by servers).
 110    *
 111    * @li <b>remote_addr != ACE_Addr::sap_any && local_addr == ACE_Addr::sap_any:</b>
 112    *     Connect to the remote address without binding a local address
 113    *     (used primarily by clients).
 114    *
 115    * @li <b>remote_addr != ACE_Addr::sap_any && local_addr != ACE_Addr::sap_any:</b>
 116    *     Bind to the local address and connect to the remote address.
 117    */
 118   int open (const ACE_Addr &remote_sap,
 119             const ACE_Addr &local_sap = ACE_Addr::sap_any,
 120             int protocol_family = ACE_PROTOCOL_FAMILY_INET,
 121             int protocol = 0,
 122             int reuse_addr = 0);
 123
 124   // = Meta-type info.
 125   typedef ACE_INET_Addr PEER_ADDR;
 126
 127   /// Dump the state of an object.
 128   void dump () const;
 129
 130   /// Declare the dynamic allocation hooks.
 131   ACE_ALLOC_HOOK_DECLARE;
 132 };
 133
 134 ACE_END_VERSIONED_NAMESPACE_DECL
 135
 136 #if defined (__ACE_INLINE__)
 137 #include "ace/SOCK_CODgram.inl"
 138 #endif /* __ACE_INLINE__ */
 139
 140 #include /**/ "ace/post.h"
 141 #endif /* ACE_SOCK_CODGRAM_H */