diff options
Diffstat (limited to 'ace/LSOCK_Acceptor.h')
-rw-r--r-- | ace/LSOCK_Acceptor.h | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/ace/LSOCK_Acceptor.h b/ace/LSOCK_Acceptor.h index 873cf98ec30..d205b37114c 100644 --- a/ace/LSOCK_Acceptor.h +++ b/ace/LSOCK_Acceptor.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// LSOCK_Aceeptor.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file LSOCK_Aceeptor.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_LOCAL_SOCK_ACCEPTOR_H #define ACE_LOCAL_SOCK_ACCEPTOR_H @@ -32,57 +29,60 @@ // Forward decl. class ACE_Reactor; +/** + * @class ACE_LSOCK_Acceptor + * + * @brief Defines the format and interface for the acceptor side of the + * local ACE_SOCK ACE_Stream. + */ class ACE_Export ACE_LSOCK_Acceptor : public ACE_SOCK_Acceptor { - // = TITLE - // Defines the format and interface for the acceptor side of the - // local ACE_SOCK ACE_Stream. public: // = Initialization methods. + /// Default constructor. ACE_LSOCK_Acceptor (void); - // Default constructor. + /// Initiate a passive mode socket. ACE_LSOCK_Acceptor (const ACE_Addr &local_sap, int reuse_addr = 0, int protocol_family = PF_UNIX, int backlog = ACE_DEFAULT_BACKLOG, int protocol = 0); - // Initiate a passive mode socket. + /// Initiate a passive mode socket. int open (const ACE_Addr &local_sap, int reuse_addr = 0, int protocol_family = PF_UNIX, int backlog = ACE_DEFAULT_BACKLOG, int protocol = 0); - // Initiate a passive mode socket. + /// Accept a new data transfer connection. int accept (ACE_LSOCK_Stream &new_ipc_sap, ACE_Addr * = 0, ACE_Time_Value *timeout = 0, int restart = 1, int reset_new_handle = 0) const; - // Accept a new data transfer connection. + /// Close down the ACE_LSOCK and remove the rendezvous point from the + /// file system. int remove (void); - // Close down the ACE_LSOCK and remove the rendezvous point from the - // file system. + /// Return the local endpoint address. int get_local_addr (ACE_Addr &) const; - // Return the local endpoint address. // = Meta-type info typedef ACE_UNIX_Addr PEER_ADDR; typedef ACE_LSOCK_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. private: + /// Address of our rendezvous point. ACE_UNIX_Addr local_addr_; - // Address of our rendezvous point. }; #endif /* ACE_LACKS_UNIX_DOMAIN_SOCKETS */ |