Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ACE_ATM_Params Class Reference

Wrapper class that simplifies the information passed to the ATM enabled ACE_ATM_Connector class. More...

#include <ATM_Params.h>

Collaboration diagram for ACE_ATM_Params:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_ATM_Params (int rw_flag=1, const char device[]=ACE_XTI_ATM_DEVICE, Param_Info *info=0, Param_Udata *udata=0, int oflag=O_RDWR, int protocol_family=AF_ATM, int protocol=ATM_PROTOCOL_DEFAULT, int type=SOCK_RAW, ACE_Protocol_Info *protocol_info=0, ACE_SOCK_GROUP g=0, u_long flags=ACE_FLAG_MULTIPOINT_C_ROOT|ACE_FLAG_MULTIPOINT_D_ROOT, int reuse_addr=0)
 ~ACE_ATM_Params ()
 Destructor.

int get_protocol_family (void) const
 Get protocol family.

void set_protocol_family (int)
 Set protocol family.

int get_protocol (void) const
 Get protocol.

void set_protocol (int)
 Set protocol.

int get_type (void) const
 Get type.

void set_type (int)
 Set type.

ACE_Protocol_Info * get_protocol_info (void)
 Get protocol info.

void set_protocol_info (ACE_Protocol_Info *)
 Set protocol info.

ACE_SOCK_GROUP get_sock_group (void)
 Get socket group.

void set_sock_group (ACE_SOCK_GROUP)
 Set socket group.

u_long get_flags (void)
 Get socket flags.

void set_flags (u_long)
 Set socket flags.

int get_reuse_addr (void) const
 Get reuse_addr flag.

void set_reuse_addr (int)
 Set reuse_addr flag.

const char * get_device (void) const
 Get device.

Param_Info * get_info (void) const
 Get info.

void set_info (Param_Info *)
 Set info.

int get_rw_flag (void) const
 Get r/w flag.

void set_rw_flag (int)
 Set r/w flag.

Param_Udata * get_user_data (void) const
 Get user data.

void set_user_data (Param_Udata *)
 Set user data.

int get_oflag (void) const
 Get open flag.

void set_oflag (int)
 Set open flag.

void dump (void) const
 Dump the state of an object.


Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.


Private Attributes

int protocol_family_
 Protocol family for sockets connections.

int protocol_
 Protocol for sockets connections.

int type_
 Type for opening sockets.

ACE_Protocol_Info * protocol_info_
 Information about the protocol.

ACE_SOCK_GROUP group_
 Socket group used (for sockets only).

u_long flags_
 Flags for sockets (for sockets only).

int reuse_addr_
 Flag for reusing address for opening sockets.

const char * device_
 Device name for XTI/ATM connections.

Param_Info * info_
 Info for XTI/ATM connections.

int rw_flag_
 R/W flag for XTI/ATM connections.

Param_Udata * udata_
 User data for XTI/ATM connections.

int oflag_
 Open flag for XTI/ATM connections.

Detailed Description

Wrapper class that simplifies the information passed to the ATM enabled ACE_ATM_Connector class.

Definition at line 60 of file ATM_Params.h.

Constructor & Destructor Documentation

ACE_INLINE ACE_ATM_Params::ACE_ATM_Params (  int  rw_flag = 1,
const char  device[] = ACE_XTI_ATM_DEVICE,
Param_Info *  info = 0,
Param_Udata *  udata = 0,
int  oflag = O_RDWR,
int  protocol_family = AF_ATM,
int  protocol = ATM_PROTOCOL_DEFAULT,
int  type = SOCK_RAW,
ACE_Protocol_Info *  protocol_info = 0,
ACE_SOCK_GROUP  g = 0,
u_long  flags = ACE_FLAG_MULTIPOINT_C_ROOT|ACE_FLAG_MULTIPOINT_D_ROOT,
int  reuse_addr = 0
) 
 

Initialize the data members. This class combines options from ACE_SOCK_Connector (, , , , , and ) and ACE_TLI_Connector (, , , , and ) so that either mechanism can be used transparently for ATM.

Definition at line 16 of file ATM_Params.inl.

References ACE_SOCK_GROUP, ACE_TRACE, Param_Info, and Param_Udata. 

00028   : protocol_family_(protocol_family),
00029     protocol_(protocol),
00030     type_(type),
00031     protocol_info_(protocol_info),
00032     group_(g),
00033     flags_(flags),
00034     reuse_addr_(reuse_addr),
00035     device_(device),
00036     info_(info),
00037     rw_flag_(rw_flag),
00038     udata_(udata),
00039     oflag_(oflag)
00040 {
00041   ACE_TRACE ("ACE_ATM_Params::ACE_ATM_Params");
00042 }

ACE_INLINE ACE_ATM_Params::~ACE_ATM_Params (   ) 
 

Destructor.

Definition at line 46 of file ATM_Params.inl.

References ACE_TRACE. 

00047 {
00048   ACE_TRACE ("ACE_ATM_Params::~ACE_ATM_Params");
00049 }

Member Function Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE void ACE_ATM_Params::dump (  void   )  const
 

Dump the state of an object.

Definition at line 8 of file ATM_Params.inl.

References ACE_TRACE. 

00009 {
00010 #if defined (ACE_HAS_DUMP)
00011   ACE_TRACE ("ACE_ATM_Params::dump");
00012 #endif /* ACE_HAS_DUMP */
00013 }

ACE_INLINE const char * ACE_ATM_Params::get_device (  void   )  const
 

Get device.

Definition at line 165 of file ATM_Params.inl.

References ACE_TRACE, and device_.

Referenced by ACE_ATM_Connector::connect(), ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00166 {
00167   ACE_TRACE ("ACE_ATM_Params::get_device");
00168   return device_;
00169 }

ACE_INLINE u_long ACE_ATM_Params::get_flags (  void   ) 
 

Get socket flags.

Definition at line 133 of file ATM_Params.inl.

References ACE_TRACE.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00134 {
00135   ACE_TRACE ("ACE_ATM_Params::get_flags");
00136   return flags_;
00137 }

ACE_INLINE Param_Info * ACE_ATM_Params::get_info (  void   )  const
 

Get info.

Definition at line 173 of file ATM_Params.inl.

References ACE_TRACE, and info_.

Referenced by ACE_ATM_Connector::connect(), ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00174 {
00175   ACE_TRACE ("ACE_ATM_Params::get_info");
00176   return info_;
00177 }

ACE_INLINE int ACE_ATM_Params::get_oflag (  void   )  const
 

Get open flag.

Definition at line 221 of file ATM_Params.inl.

References ACE_TRACE, and oflag_.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00222 {
00223   ACE_TRACE ("ACE_ATM_Params::get_oflag");
00224   return oflag_;
00225 }

ACE_INLINE int ACE_ATM_Params::get_protocol (  void   )  const
 

Get protocol.

Definition at line 69 of file ATM_Params.inl.

References ACE_TRACE, and protocol_.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00070 {
00071   ACE_TRACE ("ACE_ATM_Params::get_protocol");
00072   return protocol_;
00073 }

ACE_INLINE int ACE_ATM_Params::get_protocol_family (  void   )  const
 

Get protocol family.

Definition at line 53 of file ATM_Params.inl.

References ACE_TRACE, and protocol_family_.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00054 {
00055   ACE_TRACE ("ACE_ATM_Params::get_protocol_family");
00056   return protocol_family_;
00057 }

ACE_INLINE ACE_Protocol_Info * ACE_ATM_Params::get_protocol_info (  void   ) 
 

Get protocol info.

Definition at line 101 of file ATM_Params.inl.

References ACE_TRACE, and protocol_info_.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00102 {
00103   ACE_TRACE ("ACE_ATM_Params::get_protocol_info");
00104   return protocol_info_;
00105 }

ACE_INLINE int ACE_ATM_Params::get_reuse_addr (  void   )  const
 

Get reuse_addr flag.

Definition at line 149 of file ATM_Params.inl.

References ACE_TRACE.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00150 {
00151   ACE_TRACE ("ACE_ATM_Params::get_reuse_addr");
00152   return reuse_addr_;
00153 }

ACE_INLINE int ACE_ATM_Params::get_rw_flag (  void   )  const
 

Get r/w flag.

Definition at line 189 of file ATM_Params.inl.

References ACE_TRACE, and rw_flag_.

Referenced by ACE_ATM_Acceptor::accept(), and ACE_ATM_Connector::connect(). 

00190 {
00191   ACE_TRACE ("ACE_ATM_Params::get_rw_flag");
00192   return rw_flag_;
00193 }

ACE_INLINE ACE_SOCK_GROUP ACE_ATM_Params::get_sock_group (  void   ) 
 

Get socket group.

Definition at line 117 of file ATM_Params.inl.

References ACE_TRACE, and group_.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00118 {
00119   ACE_TRACE ("ACE_ATM_Params::get_sock_group");
00120   return group_;
00121 }

ACE_INLINE int ACE_ATM_Params::get_type (  void   )  const
 

Get type.

Definition at line 85 of file ATM_Params.inl.

References ACE_TRACE, and type_.

Referenced by ACE_ATM_Stream::open(), and ACE_ATM_Acceptor::open(). 

00086 {
00087   ACE_TRACE ("ACE_ATM_Params::get_type");
00088   return type_;
00089 }

ACE_INLINE Param_Udata * ACE_ATM_Params::get_user_data (  void   )  const
 

Get user data.

Definition at line 205 of file ATM_Params.inl.

References ACE_TRACE, and udata_.

Referenced by ACE_ATM_Acceptor::accept(), and ACE_ATM_Connector::connect(). 

00206 {
00207   ACE_TRACE ("ACE_ATM_Params::get_user_data");
00208   return udata_;
00209 }

ACE_INLINE void ACE_ATM_Params::set_flags (  u_long   ) 
 

Set socket flags.

Definition at line 141 of file ATM_Params.inl.

References ACE_TRACE.

Referenced by ACE_ATM_Stream::open(). 

00142 {
00143   ACE_TRACE ("ACE_ATM_Params::set_flags");
00144   flags_ = flags;
00145 }

ACE_INLINE void ACE_ATM_Params::set_info (  Param_Info *   ) 
 

Set info.

Definition at line 181 of file ATM_Params.inl.

References ACE_TRACE, info_, and Param_Info. 

00182 {
00183   ACE_TRACE ("ACE_ATM_Params::set_info");
00184   info_ = info;
00185 }

ACE_INLINE void ACE_ATM_Params::set_oflag (  int   ) 
 

Set open flag.

Definition at line 229 of file ATM_Params.inl.

References ACE_TRACE, and oflag_. 

00230 {
00231   ACE_TRACE ("ACE_ATM_Params::set_oflag");
00232   oflag_ = oflag;
00233 }

ACE_INLINE void ACE_ATM_Params::set_protocol (  int   ) 
 

Set protocol.

Definition at line 77 of file ATM_Params.inl.

References ACE_TRACE, and protocol_. 

00078 {
00079   ACE_TRACE ("ACE_ATM_Params::set_protocol");
00080   protocol_ = protocol;
00081 }

ACE_INLINE void ACE_ATM_Params::set_protocol_family (  int   ) 
 

Set protocol family.

Definition at line 61 of file ATM_Params.inl.

References ACE_TRACE, and protocol_family_. 

00062 {
00063   ACE_TRACE ("ACE_ATM_Params::set_protocol_family");
00064   protocol_family_ = family;
00065 }

ACE_INLINE void ACE_ATM_Params::set_protocol_info (  ACE_Protocol_Info *   ) 
 

Set protocol info.

Definition at line 109 of file ATM_Params.inl.

References ACE_TRACE, and protocol_info_. 

00110 {
00111   ACE_TRACE ("ACE_ATM_Params::set_protocol_info");
00112   protocol_info_ = protocol_info;
00113 }

ACE_INLINE void ACE_ATM_Params::set_reuse_addr (  int   ) 
 

Set reuse_addr flag.

Definition at line 157 of file ATM_Params.inl.

References ACE_TRACE. 

00158 {
00159   ACE_TRACE ("ACE_ATM_Params::set_reuse_addr");
00160   reuse_addr_ = reuse_addr;
00161 }

ACE_INLINE void ACE_ATM_Params::set_rw_flag (  int   ) 
 

Set r/w flag.

Definition at line 197 of file ATM_Params.inl.

References ACE_TRACE, and rw_flag_. 

00198 {
00199   ACE_TRACE ("ACE_ATM_Params::set_rw_flag");
00200   rw_flag_ = rw_flag;
00201 }

ACE_INLINE void ACE_ATM_Params::set_sock_group (  ACE_SOCK_GROUP   ) 
 

Set socket group.

Definition at line 125 of file ATM_Params.inl.

References ACE_SOCK_GROUP, ACE_TRACE, and group_. 

00126 {
00127   ACE_TRACE ("ACE_ATM_Params::set_sock_group");
00128   group_ = g;
00129 }

ACE_INLINE void ACE_ATM_Params::set_type (  int   ) 
 

Set type.

Definition at line 93 of file ATM_Params.inl.

References ACE_TRACE, and type_. 

00094 {
00095   ACE_TRACE ("ACE_ATM_Params::set_type");
00096   type_ = type;
00097 }

ACE_INLINE void ACE_ATM_Params::set_user_data (  Param_Udata *   ) 
 

Set user data.

Definition at line 213 of file ATM_Params.inl.

References ACE_TRACE, Param_Udata, and udata_. 

00214 {
00215   ACE_TRACE ("ACE_ATM_Params::set_user_data");
00216   udata_ = udata;
00217 }

Member Data Documentation

ACE_ATM_Params::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Definition at line 166 of file ATM_Params.h.

const char* ACE_ATM_Params::device_ [private]
 

Device name for XTI/ATM connections.

Definition at line 191 of file ATM_Params.h.

Referenced by get_device().

u_long ACE_ATM_Params::flags_ [private]
 

Flags for sockets (for sockets only).

Definition at line 185 of file ATM_Params.h.

ACE_SOCK_GROUP ACE_ATM_Params::group_ [private]
 

Socket group used (for sockets only).

Definition at line 182 of file ATM_Params.h.

Referenced by get_sock_group(), and set_sock_group().

Param_Info* ACE_ATM_Params::info_ [private]
 

Info for XTI/ATM connections.

Definition at line 194 of file ATM_Params.h.

Referenced by get_info(), and set_info().

int ACE_ATM_Params::oflag_ [private]
 

Open flag for XTI/ATM connections.

Definition at line 203 of file ATM_Params.h.

Referenced by get_oflag(), and set_oflag().

int ACE_ATM_Params::protocol_ [private]
 

Protocol for sockets connections.

Definition at line 173 of file ATM_Params.h.

Referenced by get_protocol(), and set_protocol().

int ACE_ATM_Params::protocol_family_ [private]
 

Protocol family for sockets connections.

Definition at line 170 of file ATM_Params.h.

Referenced by get_protocol_family(), and set_protocol_family().

ACE_Protocol_Info* ACE_ATM_Params::protocol_info_ [private]
 

Information about the protocol.

Definition at line 179 of file ATM_Params.h.

Referenced by get_protocol_info(), and set_protocol_info().

int ACE_ATM_Params::reuse_addr_ [private]
 

Flag for reusing address for opening sockets.

Definition at line 188 of file ATM_Params.h.

int ACE_ATM_Params::rw_flag_ [private]
 

R/W flag for XTI/ATM connections.

Definition at line 197 of file ATM_Params.h.

Referenced by get_rw_flag(), and set_rw_flag().

int ACE_ATM_Params::type_ [private]
 

Type for opening sockets.

Definition at line 176 of file ATM_Params.h.

Referenced by get_type(), and set_type().

Param_Udata* ACE_ATM_Params::udata_ [private]
 

User data for XTI/ATM connections.

Definition at line 200 of file ATM_Params.h.

Referenced by get_user_data(), and set_user_data().

The documentation for this class was generated from the following files:
Generated on Thu Nov 9 11:20:10 2006 for ACE by doxygen 1.3.6