diff options
Diffstat (limited to 'ace/SPIPE_Addr.h')
| -rw-r--r-- | ace/SPIPE_Addr.h | 76 |
1 files changed, 37 insertions, 39 deletions
diff --git a/ace/SPIPE_Addr.h b/ace/SPIPE_Addr.h index 063c2382315..c4878d5d374 100644 --- a/ace/SPIPE_Addr.h +++ b/ace/SPIPE_Addr.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// SPIPE_Addr.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file SPIPE_Addr.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_SPIPE_ADDR_H #define ACE_SPIPE_ADDR_H @@ -26,74 +23,75 @@ #include "ace/ACE.h" +/** + * @class ACE_SPIPE_Addr + * + * @brief Defines the SVR4 STREAM pipe address family address format. + */ class ACE_Export ACE_SPIPE_Addr : public ACE_Addr { - // = TITLE - // Defines the SVR4 STREAM pipe address family address format. public: // = Initialization methods. + /// Default constructor. ACE_SPIPE_Addr (void); - // Default constructor. + /// Copy constructor. ACE_SPIPE_Addr (const ACE_SPIPE_Addr &sa); - // Copy constructor. + /// Create a ACE_SPIPE_Addr from a rendezvous point in the file + /// system. ACE_SPIPE_Addr (const ACE_TCHAR *rendezvous_point, gid_t = 0, uid_t = 0); - // Create a ACE_SPIPE_Addr from a rendezvous point in the file - // system. + /// Acts like a copy constructor... int set (const ACE_SPIPE_Addr &sa); - // Acts like a copy constructor... + /// Create a ACE_SPIPE_Addr from a rendezvous point in the file + /// system. int set (const ACE_TCHAR *rendezvous_point, gid_t = 0, uid_t = 0); - // Create a ACE_SPIPE_Addr from a rendezvous point in the file - // system. + /// Return a pointer to the address. virtual void *get_addr (void) const; - // Return a pointer to the address. + /// Set a pointer to the underlying network address. virtual void set_addr (void *addr, int len); - // Set a pointer to the underlying network address. + /// Transform the current address into string format. virtual int addr_to_string (ACE_TCHAR *addr, size_t) const; - // Transform the current address into string format. + /// Transform the string into the current addressing format. virtual int string_to_addr (const ACE_TCHAR *addr); - // Transform the string into the current addressing format. // = Equality/inequality tests + /// Check for equality. int operator == (const ACE_SPIPE_Addr &SAP) const; - // Check for equality. + /// Check for inequality int operator != (const ACE_SPIPE_Addr &SAP) const; - // Check for inequality // = SPIPE-specific address operations + /// Pathname of rendezvous point in file system. const ACE_TCHAR *get_path_name (void) const; - // Pathname of rendezvous point in file system. + /// Get user id. + /// Set user id. uid_t user_id (void) const; - // Get user id. void user_id (uid_t uid); - // Set user id. + /// Set group ids. + /// Get group ids. void group_id (gid_t gid); - // Set group ids. gid_t group_id (void) const; - // Get group ids. + /// 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: + /// Contains security attributes. struct SPIPE_Addr { - // = TITLE - // Contains security attributes. - gid_t gid_; // Group id. |