diff options
Diffstat (limited to 'ace/Addr.h')
| -rw-r--r-- | ace/Addr.h | 72 |
1 files changed, 36 insertions, 36 deletions
diff --git a/ace/Addr.h b/ace/Addr.h index 98802b3aa12..6db4eaa14eb 100644 --- a/ace/Addr.h +++ b/ace/Addr.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// Addr.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file Addr.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_ADDR_H #define ACE_ADDR_H @@ -24,81 +21,84 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ +/** + * @class ACE_Addr + * + * @brief Defines the base class for the "address family independent" + * address format. + */ class ACE_Export ACE_Addr { - // = TITLE - // Defines the base class for the "address family independent" - // address format. public: // = Initialization and termination methods. + /// Initializes instance variables. ACE_Addr (int type = -1, int size = -1); - // Initializes instance variables. + /// Destructor. virtual ~ACE_Addr (void); - // Destructor. // = Get/set the size of the address. + /// Return the size of the address. int get_size (void) const; - // Return the size of the address. + /// Sets the size of the address. void set_size (int size); - // Sets the size of the address. // = Get/set the type of the address. + /// Get the type of the address. int get_type (void) const; - // Get the type of the address. + /// Set the type of the address. void set_type (int type); - // Set the type of the address. + /// Return a pointer to the address. virtual void *get_addr (void) const; - // Return a pointer to the address. + /// Set a pointer to the address. virtual void set_addr (void *, int len); - // Set a pointer to the address. // = Equality/inequality tests + /// Check for address equality. int operator == (const ACE_Addr &sap) const; - // Check for address equality. + /// Check for address inequality. int operator != (const ACE_Addr &sap) const; - // Check for address inequality. + /// Initializes instance variables. void base_set (int type, int size); - // Initializes instance variables. #if defined (ACE_HAS_BROKEN_SAP_ANY) + /// Wild-card address. static const ACE_Addr &sap_any (void); - // Wild-card address. // This #define works around broken C++ compilers... #define sap_any sap_any() #else + /// Wild-card address. static const ACE_Addr sap_any; - // Wild-card address. #endif /* ACE_HAS_BROKEN_SAP_ANY */ + /// Returns a hash value. This should be overwritten by a subclass + /// which can produce a better hash value. virtual u_long hash (void) const; - // Returns a hash value. This should be overwritten by a subclass - // which can produce a better hash value. + /// 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: + /// e.g., AF_UNIX, AF_INET, AF_SPIPE, etc. int addr_type_; - // e.g., AF_UNIX, AF_INET, AF_SPIPE, etc. + /// Number of bytes in the address. int addr_size_; - // Number of bytes in the address. }; #if defined (__ACE_INLINE__) |