diff options
Diffstat (limited to 'ace/LSOCK_CODgram.h')
| -rw-r--r-- | ace/LSOCK_CODgram.h | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/ace/LSOCK_CODgram.h b/ace/LSOCK_CODgram.h index 919d3f26c05..f9bbf138654 100644 --- a/ace/LSOCK_CODgram.h +++ b/ace/LSOCK_CODgram.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// LSOCK_CODgram.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file LSOCK_CODgram.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_LOCAL_SOCK_CODGRAM_H #define ACE_LOCAL_SOCK_CODGRAM_H @@ -29,39 +26,42 @@ #if !defined (ACE_LACKS_UNIX_DOMAIN_SOCKETS) +/** + * @class ACE_LSOCK_CODgram + * + * @brief Defines the member functions for the <ACE_LSOCK> connected + * datagram abstraction. + */ class ACE_Export ACE_LSOCK_CODgram : public ACE_SOCK_CODgram, public ACE_LSOCK { - // = TITLE - // Defines the member functions for the <ACE_LSOCK> connected - // datagram abstraction. public: // = Initialization methods. + /// Default constructor. ACE_LSOCK_CODgram (void); - // Default constructor. + /// Initiate a connected-datagram. ACE_LSOCK_CODgram (const ACE_Addr &remote_sap, const ACE_Addr &local_sap = ACE_Addr::sap_any, int protocol_family = PF_UNIX, int protocol = 0); - // Initiate a connected-datagram. + /// Initiate a connected-datagram. int open (const ACE_Addr &remote_sap, const ACE_Addr &local_sap = ACE_Addr::sap_any, int protocol_family = PF_UNIX, int protocol = 0); - // Initiate a connected-datagram. + /// Get underlying handle. ACE_HANDLE get_handle (void) const; - // Get underlying handle. + /// Set underlying handle. void set_handle (ACE_HANDLE); - // Set underlying handle. + /// 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. }; #if !defined (ACE_LACKS_INLINE_FUNCTIONS) |