diff options
Diffstat (limited to 'ace/SOCK_Acceptor.h')
| -rw-r--r-- | ace/SOCK_Acceptor.h | 135 |
1 files changed, 72 insertions, 63 deletions
diff --git a/ace/SOCK_Acceptor.h b/ace/SOCK_Acceptor.h index b4871f328c8..5a65b0e46af 100644 --- a/ace/SOCK_Acceptor.h +++ b/ace/SOCK_Acceptor.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// SOCK_Acceptor.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file SOCK_Acceptor.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_SOCK_ACCEPTOR_H #define ACE_SOCK_ACCEPTOR_H @@ -26,32 +23,38 @@ #include "ace/Time_Value.h" +/** + * @class ACE_SOCK_Acceptor + * + * @brief Defines a factory that creates new <ACE_Stream>s passively. + * + * The <ACE_SOCK_Acceptor> has its own "passive-mode" socket. + * This serves as a factory to create so-called "data-mode" + * sockets, which are what the <ACE_SOCK_Stream> encapsulates. + * Therefore, by inheriting from <ACE_SOCK>, <ACE_SOCK_Acceptor> + * gets its very own socket. + */ class ACE_Export ACE_SOCK_Acceptor : public ACE_SOCK { - // = TITLE - // Defines a factory that creates new <ACE_Stream>s passively. - // - // = DESCRIPTION - // The <ACE_SOCK_Acceptor> has its own "passive-mode" socket. - // This serves as a factory to create so-called "data-mode" - // sockets, which are what the <ACE_SOCK_Stream> encapsulates. - // Therefore, by inheriting from <ACE_SOCK>, <ACE_SOCK_Acceptor> - // gets its very own socket. public: // = Initialization and termination methods. + /// Default constructor. ACE_SOCK_Acceptor (void); - // Default constructor. + /** + * Initialize a passive-mode BSD-style acceptor socket (no QoS). + * <local_sap> is the address that we're going to listen for + * connections on. If <reuse_addr> is 1 then we'll use the + * <SO_REUSEADDR> to reuse this address. + */ ACE_SOCK_Acceptor (const ACE_Addr &local_sap, int reuse_addr = 0, int protocol_family = PF_INET, int backlog = ACE_DEFAULT_BACKLOG, int protocol = 0); - // Initialize a passive-mode BSD-style acceptor socket (no QoS). - // <local_sap> is the address that we're going to listen for - // connections on. If <reuse_addr> is 1 then we'll use the - // <SO_REUSEADDR> to reuse this address. + /// Initialize a passive-mode QoS-enabled acceptor socket. Returns 0 + /// on success and -1 on failure. ACE_SOCK_Acceptor (const ACE_Addr &local_sap, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, @@ -60,20 +63,22 @@ public: int protocol_family, int backlog = ACE_DEFAULT_BACKLOG, int protocol = 0); - // Initialize a passive-mode QoS-enabled acceptor socket. Returns 0 - // on success and -1 on failure. + /** + * Initialize a passive-mode BSD-style acceptor socket (no QoS). + * <local_sap> is the address that we're going to listen for + * connections on. If <reuse_addr> is 1 then we'll use the + * <SO_REUSEADDR> to reuse this address. Returns 0 on success and + * -1 on failure. + */ int open (const ACE_Addr &local_sap, int reuse_addr = 0, int protocol_family = PF_INET, int backlog = ACE_DEFAULT_BACKLOG, int protocol = 0); - // Initialize a passive-mode BSD-style acceptor socket (no QoS). - // <local_sap> is the address that we're going to listen for - // connections on. If <reuse_addr> is 1 then we'll use the - // <SO_REUSEADDR> to reuse this address. Returns 0 on success and - // -1 on failure. + /// Initialize a passive-mode QoS-enabled acceptor socket. Returns 0 + /// on success and -1 on failure. int open (const ACE_Addr &local_sap, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, @@ -82,74 +87,78 @@ public: int protocol_family, int backlog = ACE_DEFAULT_BACKLOG, int protocol = 0); - // Initialize a passive-mode QoS-enabled acceptor socket. Returns 0 - // on success and -1 on failure. + /// Default dtor. ~ACE_SOCK_Acceptor (void); - // Default dtor. // = Passive connection <accept> methods. + /** + * Accept a new <ACE_SOCK_Stream> connection. A <timeout> of 0 + * means block forever, a <timeout> of {0, 0} means poll. <restart> + * == 1 means "restart if interrupted," i.e., if errno == EINTR. + * Note that <new_stream> inherits the "blocking mode" of <this> + * <ACE_SOCK_Acceptor>, i.e., if <this> acceptor factory is in + * non-blocking mode, the <net_stream> will be in non-blocking mode + * and vice versa. + */ int accept (ACE_SOCK_Stream &new_stream, ACE_Addr *remote_addr = 0, ACE_Time_Value *timeout = 0, int restart = 1, int reset_new_handle = 0) const; - // Accept a new <ACE_SOCK_Stream> connection. A <timeout> of 0 - // means block forever, a <timeout> of {0, 0} means poll. <restart> - // == 1 means "restart if interrupted," i.e., if errno == EINTR. - // Note that <new_stream> inherits the "blocking mode" of <this> - // <ACE_SOCK_Acceptor>, i.e., if <this> acceptor factory is in - // non-blocking mode, the <net_stream> will be in non-blocking mode - // and vice versa. + /** + * Accept a new <ACE_SOCK_Stream> connection using the QoS + * information in <qos_params>. A <timeout> of 0 means block + * forever, a <timeout> of {0, 0} means poll. <restart> == 1 means + * "restart if interrupted," i.e., if errno == EINTR. Note that + * <new_stream> inherits the "blocking mode" of <this> + * <ACE_SOCK_Acceptor>, i.e., if <this> acceptor factory is in + * non-blocking mode, the <net_stream> will be in non-blocking mode + * and vice versa. + */ int accept (ACE_SOCK_Stream &new_stream, ACE_Accept_QoS_Params qos_params, ACE_Addr *remote_addr = 0, ACE_Time_Value *timeout = 0, int restart = 1, int reset_new_handle = 0) const; - // Accept a new <ACE_SOCK_Stream> connection using the QoS - // information in <qos_params>. A <timeout> of 0 means block - // forever, a <timeout> of {0, 0} means poll. <restart> == 1 means - // "restart if interrupted," i.e., if errno == EINTR. Note that - // <new_stream> inherits the "blocking mode" of <this> - // <ACE_SOCK_Acceptor>, i.e., if <this> acceptor factory is in - // non-blocking mode, the <net_stream> will be in non-blocking mode - // and vice versa. // = Meta-type info typedef ACE_INET_Addr PEER_ADDR; typedef ACE_SOCK_Stream PEER_STREAM; + /// Dump the state of an object. void dump (void) const; - // Dump the state of an object. + /// Declare the dynamic allocation hooks. ACE_ALLOC_HOOK_DECLARE; - // Declare the dynamic allocation hooks. protected: + /// Perform operations that must occur before <ACE_OS::accept> is + /// called. int shared_accept_start (ACE_Time_Value *timeout, int restart, int &in_blocking_mode) const; - // Perform operations that must occur before <ACE_OS::accept> is - // called. + /// Perform operations that must occur after <ACE_OS::accept> is + /// called. int shared_accept_finish (ACE_SOCK_Stream new_stream, int in_blocking_mode, int reset_new_handle) const; - // Perform operations that must occur after <ACE_OS::accept> is - // called. + /** + * This method factors out the common <open> code and is called by + * both the QoS-enabled <open> method and the BSD-style <open> + * method. + */ int shared_open (const ACE_Addr &local_sap, int protocol_family, int backlog); - // This method factors out the common <open> code and is called by - // both the QoS-enabled <open> method and the BSD-style <open> - // method. private: + /// Do not allow this function to percolate up to this interface... int get_remote_addr (ACE_Addr &) const; - // Do not allow this function to percolate up to this interface... }; #if !defined (ACE_LACKS_INLINE_FUNCTIONS) |