diff options
Diffstat (limited to 'ace/FILE_Addr.h')
| -rw-r--r-- | ace/FILE_Addr.h | 62 |
1 files changed, 31 insertions, 31 deletions
diff --git a/ace/FILE_Addr.h b/ace/FILE_Addr.h index 29d696bfab2..b0307e6f856 100644 --- a/ace/FILE_Addr.h +++ b/ace/FILE_Addr.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// FILE_Addr.h -// -// = AUTHOR -// Douglas C. Schmidt <schmidt@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file FILE_Addr.h + * + * $Id$ + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_FILE_ADDR_H #define ACE_FILE_ADDR_H @@ -26,55 +23,58 @@ #include "ace/Flag_Manip.h" +/** + * @class ACE_FILE_Addr + * + * @brief Defines the FILE address family address format. + */ class ACE_Export ACE_FILE_Addr : public ACE_Addr { - // = TITLE - // Defines the FILE address family address format. public: // = Initialization methods. + /// Default constructor. ACE_FILE_Addr (void); - // Default constructor. + /// Copy constructor. ACE_FILE_Addr (const ACE_FILE_Addr &sa); - // Copy constructor. + /// Acts like a copy constructor. If <sa> == ACE_Addr::sap_any then + /// create a temporary filename using <ACE_OS::mktemp>. int set (const ACE_FILE_Addr &sa); - // Acts like a copy constructor. If <sa> == ACE_Addr::sap_any then - // create a temporary filename using <ACE_OS::mktemp>. + /// Create a ACE_FILE_Addr from a pathname. ACE_EXPLICIT ACE_FILE_Addr (const ACE_TCHAR *filename); - // Create a ACE_FILE_Addr from a pathname. + /// Create a ACE_FILE_Addr from a pathname. int set (const ACE_TCHAR *filename); - // Create a ACE_FILE_Addr from a pathname. + /// Assignment operator. ACE_FILE_Addr &operator= (const ACE_FILE_Addr &); - // Assignment operator. + /// Return a pointer to the address. virtual void *get_addr (void) const; - // Return a pointer to the 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. + /// Compare two addresses for equality. int operator == (const ACE_FILE_Addr &SAP) const; - // Compare two addresses for equality. + /// Compare two addresses for inequality. int operator != (const ACE_FILE_Addr &SAP) const; - // Compare two addresses for inequality. + /// Return the path name used for the rendezvous point. const ACE_TCHAR *get_path_name (void) const; - // Return the path name used for the rendezvous point. + /// 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: + /// Name of the file. ACE_TCHAR filename_[MAXNAMLEN + 1]; - // Name of the file. }; #if defined (__ACE_INLINE__) |