diff options
Diffstat (limited to 'ace/ATM_Params.h')
| -rw-r--r-- | ace/ATM_Params.h | 105 |
1 files changed, 53 insertions, 52 deletions
diff --git a/ace/ATM_Params.h b/ace/ATM_Params.h index 9c8fb6de383..5544bd3afcd 100644 --- a/ace/ATM_Params.h +++ b/ace/ATM_Params.h @@ -1,17 +1,14 @@ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// ATM_Params.h -// -// = AUTHOR -// Joe Hoffert <joeh@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file ATM_Params.h + * + * $Id$ + * + * @author Joe Hoffert <joeh@cs.wustl.edu> + */ +//============================================================================= + #ifndef ACE_ATM_PARAMS_H #define ACE_ATM_PARAMS_H @@ -49,12 +46,22 @@ typedef int Param_Info; typedef int Param_Udata; #endif /* ACE_HAS_FORE_ATM_XTI || ACE_HAS_FORE_ATM_WS2 || ACE_HAS_LINUX_ATM */ +/** + * @class ACE_ATM_Params + * + * @brief Wrapper class that simplifies the information passed to the ATM + * enabled <ACE_ATM_Connector> class. + */ class ACE_Export ACE_ATM_Params { - // = TITLE - // Wrapper class that simplifies the information passed to the ATM - // enabled <ACE_ATM_Connector> class. public: + /** + * Initialize the data members. This class combines options from + * ACE_SOCK_Connector (<protocol_family>, <protocol>, <type>, + * <protocol_info>, <group>, and <flags>) and + * ACE_TLI_Connector (<device>, <info>, <rw_flag>, <oflag>, and <udata>) + * so that either mechanism can be used transparently for ATM. + */ ACE_ATM_Params (int rw_flag = 1, const char device[] = ACE_XTI_ATM_DEVICE, Param_Info *info = 0, @@ -62,7 +69,7 @@ public: int oflag = O_RDWR, int protocol_family = AF_ATM, int protocol = ATM_PROTOCOL_DEFAULT, - int type = + int type = #if defined (ACE_HAS_LINUX_ATM) SOCK_DGRAM, #else @@ -70,107 +77,102 @@ public: #endif /* ACE_HAS_LINUX_ATM */ ACE_Protocol_Info *protocol_info = 0, ACE_SOCK_GROUP g = 0, - u_long flags - = ACE_FLAG_MULTIPOINT_C_ROOT + u_long flags + = ACE_FLAG_MULTIPOINT_C_ROOT | ACE_FLAG_MULTIPOINT_D_ROOT, // connector by default int reuse_addr = 0); - // Initialize the data members. This class combines options from - // ACE_SOCK_Connector (<protocol_family>, <protocol>, <type>, - // <protocol_info>, <group>, and <flags>) and - // ACE_TLI_Connector (<device>, <info>, <rw_flag>, <oflag>, and <udata>) - // so that either mechanism can be used transparently for ATM. ~ACE_ATM_Params (); + /// Get/set protocol family. int get_protocol_family (void) const; void set_protocol_family (int); - // Get/set protocol family. + /// Get/set protocol. int get_protocol (void) const; void set_protocol (int); - // Get/set protocol. + /// Get/set type. int get_type (void) const; void set_type (int); - // Get/set type. + /// Get/set protocol info. ACE_Protocol_Info *get_protocol_info( void ); void set_protocol_info( ACE_Protocol_Info *); - // Get/set protocol info. + /// Get/set socket group. ACE_SOCK_GROUP get_sock_group( void ); void set_sock_group( ACE_SOCK_GROUP ); - // Get/set socket group. + /// Get/set socket flags. u_long get_flags( void ); void set_flags( u_long ); - // Get/set socket flags. + /// Get/set reuse_addr flag. int get_reuse_addr (void) const; void set_reuse_addr (int); - // Get/set reuse_addr flag. + /// Get device. const char* get_device (void) const; - // Get device. + /// Get/set info. Param_Info* get_info (void) const; void set_info (Param_Info *); - // Get/set info. + /// Get/set r/w flag. int get_rw_flag (void) const; void set_rw_flag (int); - // Get/set r/w flag. + /// Get/set user data. Param_Udata* get_user_data (void) const; void set_user_data (Param_Udata*); - // Get/set user data. + /// /set open flag. int get_oflag (void) const; void set_oflag (int); - // /set open flag. + /// 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: + /// Protocol family for sockets connections. int protocol_family_; - // Protocol family for sockets connections. + /// Protocol for sockets connections. int protocol_; - // Protocol for sockets connections. + /// Type for opening sockets. int type_; - // Type for opening sockets. + /// Information about the protocol. ACE_Protocol_Info *protocol_info_; - // Information about the protocol. + /// Socket group used (for sockets only). ACE_SOCK_GROUP group_; - // Socket group used (for sockets only). + /// Flags for sockets (for sockets only). u_long flags_; - // Flags for sockets (for sockets only). + /// Flag for reusing address for opening sockets. int reuse_addr_; - // Flag for reusing address for opening sockets. + /// Device name for XTI/ATM connections. const char *device_; - // Device name for XTI/ATM connections. + /// Info for XTI/ATM connections. Param_Info *info_; - // Info for XTI/ATM connections. + /// R/W flag for XTI/ATM connections. int rw_flag_; - // R/W flag for XTI/ATM connections. + /// User data for XTI/ATM connections. Param_Udata *udata_; - // User data for XTI/ATM connections. + /// Open flag for XTI/ATM connections. int oflag_; - // Open flag for XTI/ATM connections. }; #if defined (__ACE_INLINE__) @@ -180,4 +182,3 @@ private: #endif /* ACE_HAS_ATM */ #include "ace/post.h" #endif /* ACE_ATM_PARAMS_H */ - |