Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

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 Methods

 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. More...

int get_protocol_family (void) const
 Get protocol family. More...

void set_protocol_family (int)
 Set protocol family. More...

int get_protocol (void) const
 Get protocol. More...

void set_protocol (int)
 Set protocol. More...

int get_type (void) const
 Get type. More...

void set_type (int)
 Set type. More...

ACE_Protocol_Info * get_protocol_info (void)
 Get protocol info. More...

void set_protocol_info (ACE_Protocol_Info *)
 Set protocol info. More...

ACE_SOCK_GROUP get_sock_group (void)
 Get socket group. More...

void set_sock_group (ACE_SOCK_GROUP)
 Set socket group. More...

u_long get_flags (void)
 Get socket flags. More...

void set_flags (u_long)
 Set socket flags. More...

int get_reuse_addr (void) const
 Get reuse_addr flag. More...

void set_reuse_addr (int)
 Set reuse_addr flag. More...

const char * get_device (void) const
 Get device. More...

Param_Info * get_info (void) const
 Get info. More...

void set_info (Param_Info *)
 Set info. More...

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

void set_rw_flag (int)
 Set r/w flag. More...

Param_Udata * get_user_data (void) const
 Get user data. More...

void set_user_data (Param_Udata *)
 Set user data. More...

int get_oflag (void) const
 Get open flag. More...

void set_oflag (int)
 Set open flag. More...

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


Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...


Private Attributes

int protocol_family_
 Protocol family for sockets connections. More...

int protocol_
 Protocol for sockets connections. More...

int type_
 Type for opening sockets. More...

ACE_Protocol_Info * protocol_info_
 Information about the protocol. More...

ACE_SOCK_GROUP group_
 Socket group used (for sockets only). More...

u_long flags_
 Flags for sockets (for sockets only). More...

int reuse_addr_
 Flag for reusing address for opening sockets. More...

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

Param_Info * info_
 Info for XTI/ATM connections. More...

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

Param_Udata * udata_
 User data for XTI/ATM connections. More...

int oflag_
 Open flag for XTI/ATM connections. More...

Detailed Description

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

Definition at line 58 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 (<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.

Definition at line 6 of file ATM_Params.i.

References ACE_SOCK_GROUP, ACE_TRACE, Param_Info, and Param_Udata. 

00018   : protocol_family_(protocol_family),
00019     protocol_(protocol),
00020     type_(type),
00021     protocol_info_(protocol_info),
00022     group_(g),
00023     flags_(flags),
00024     reuse_addr_(reuse_addr),
00025     device_(device),
00026     info_(info),
00027     rw_flag_(rw_flag),
00028     udata_(udata),
00029     oflag_(oflag)
00030 {
00031   ACE_TRACE ("ACE_ATM_Params::ACE_ATM_Params");
00032 }

ACE_INLINE ACE_ATM_Params::~ACE_ATM_Params (    ) 
 

Destructor.

Definition at line 36 of file ATM_Params.i.

References ACE_TRACE. 

00037 {
00038   ACE_TRACE ("ACE_ATM_Params::~ACE_ATM_Params");
00039 }

Member Function Documentation

void ACE_ATM_Params::dump (  void    )  const
 

Dump the state of an object.

Definition at line 17 of file ATM_Params.cpp.

References ACE_TRACE. 

00018 {
00019   ACE_TRACE ("ACE_ATM_Params::dump");
00020 }

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

Get device.

Definition at line 155 of file ATM_Params.i.

References ACE_TRACE, and device_.

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

00156 {
00157   ACE_TRACE ("ACE_ATM_Params::get_device");
00158   return device_;
00159 }

ACE_INLINE u_long ACE_ATM_Params::get_flags (  void    ) 
 

Get socket flags.

Definition at line 123 of file ATM_Params.i.

References ACE_TRACE, and flags_.

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

00124 {
00125   ACE_TRACE ("ACE_ATM_Params::get_flags");
00126   return flags_;
00127 }

ACE_INLINE Param_Info * ACE_ATM_Params::get_info (  void    )  const
 

Get info.

Definition at line 163 of file ATM_Params.i.

References ACE_TRACE, and info_.

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

00164 {
00165   ACE_TRACE ("ACE_ATM_Params::get_info");
00166   return info_;
00167 }

ACE_INLINE int ACE_ATM_Params::get_oflag (  void    )  const
 

Get open flag.

Definition at line 211 of file ATM_Params.i.

References ACE_TRACE, and oflag_.

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

00212 {
00213   ACE_TRACE ("ACE_ATM_Params::get_oflag");
00214   return oflag_;
00215 }

ACE_INLINE int ACE_ATM_Params::get_protocol (  void    )  const
 

Get protocol.

Definition at line 59 of file ATM_Params.i.

References ACE_TRACE, and protocol_.

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

00060 {
00061   ACE_TRACE ("ACE_ATM_Params::get_protocol");
00062   return protocol_;
00063 }

ACE_INLINE int ACE_ATM_Params::get_protocol_family (  void    )  const
 

Get protocol family.

Definition at line 43 of file ATM_Params.i.

References ACE_TRACE, and protocol_family_.

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

00044 {
00045   ACE_TRACE ("ACE_ATM_Params::get_protocol_family");
00046   return protocol_family_;
00047 }

ACE_INLINE ACE_Protocol_Info * ACE_ATM_Params::get_protocol_info (  void    ) 
 

Get protocol info.

Definition at line 91 of file ATM_Params.i.

References ACE_TRACE, and protocol_info_.

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

00092 {
00093   ACE_TRACE ("ACE_ATM_Params::get_protocol_info");
00094   return protocol_info_;
00095 }

ACE_INLINE int ACE_ATM_Params::get_reuse_addr (  void    )  const
 

Get reuse_addr flag.

Definition at line 139 of file ATM_Params.i.

References ACE_TRACE, and reuse_addr_.

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

00140 {
00141   ACE_TRACE ("ACE_ATM_Params::get_reuse_addr");
00142   return reuse_addr_;
00143 }

ACE_INLINE int ACE_ATM_Params::get_rw_flag (  void    )  const
 

Get r/w flag.

Definition at line 179 of file ATM_Params.i.

References ACE_TRACE, and rw_flag_.

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

00180 {
00181   ACE_TRACE ("ACE_ATM_Params::get_rw_flag");
00182   return rw_flag_;
00183 }

ACE_INLINE ACE_SOCK_GROUP ACE_ATM_Params::get_sock_group (  void    ) 
 

Get socket group.

Definition at line 107 of file ATM_Params.i.

References ACE_TRACE, and group_.

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

00108 {
00109   ACE_TRACE ("ACE_ATM_Params::get_sock_group");
00110   return group_;
00111 }

ACE_INLINE int ACE_ATM_Params::get_type (  void    )  const
 

Get type.

Definition at line 75 of file ATM_Params.i.

References ACE_TRACE, and type_.

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

00076 {
00077   ACE_TRACE ("ACE_ATM_Params::get_type");
00078   return type_;
00079 }

ACE_INLINE Param_Udata * ACE_ATM_Params::get_user_data (  void    )  const
 

Get user data.

Definition at line 195 of file ATM_Params.i.

References ACE_TRACE, and udata_.

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

00196 {
00197   ACE_TRACE ("ACE_ATM_Params::get_user_data");
00198   return udata_;
00199 }

ACE_INLINE void ACE_ATM_Params::set_flags (  u_long    ) 
 

Set socket flags.

Definition at line 131 of file ATM_Params.i.

References ACE_TRACE, and flags_.

Referenced by ACE_ATM_Stream::open. 

00132 {
00133   ACE_TRACE ("ACE_ATM_Params::set_flags");
00134   flags_ = flags;
00135 }

ACE_INLINE void ACE_ATM_Params::set_info (  Param_Info *    ) 
 

Set info.

Definition at line 171 of file ATM_Params.i.

References ACE_TRACE, info_, and Param_Info. 

00172 {
00173   ACE_TRACE ("ACE_ATM_Params::set_info");
00174   info_ = info;
00175 }

ACE_INLINE void ACE_ATM_Params::set_oflag (  int    ) 
 

Set open flag.

Definition at line 219 of file ATM_Params.i.

References ACE_TRACE, and oflag_. 

00220 {
00221   ACE_TRACE ("ACE_ATM_Params::set_oflag");
00222   oflag_ = oflag;
00223 }

ACE_INLINE void ACE_ATM_Params::set_protocol (  int    ) 
 

Set protocol.

Definition at line 67 of file ATM_Params.i.

References ACE_TRACE, and protocol_. 

00068 {
00069   ACE_TRACE ("ACE_ATM_Params::set_protocol");
00070   protocol_ = protocol;
00071 }

ACE_INLINE void ACE_ATM_Params::set_protocol_family (  int    ) 
 

Set protocol family.

Definition at line 51 of file ATM_Params.i.

References ACE_TRACE, and protocol_family_. 

00052 {
00053   ACE_TRACE ("ACE_ATM_Params::set_protocol_family");
00054   protocol_family_ = family;
00055 }

ACE_INLINE void ACE_ATM_Params::set_protocol_info (  ACE_Protocol_Info *    ) 
 

Set protocol info.

Definition at line 99 of file ATM_Params.i.

References ACE_TRACE, and protocol_info_. 

00100 {
00101   ACE_TRACE ("ACE_ATM_Params::set_protocol_info");
00102   protocol_info_ = protocol_info;
00103 }

ACE_INLINE void ACE_ATM_Params::set_reuse_addr (  int    ) 
 

Set reuse_addr flag.

Definition at line 147 of file ATM_Params.i.

References ACE_TRACE, and reuse_addr_. 

00148 {
00149   ACE_TRACE ("ACE_ATM_Params::set_reuse_addr");
00150   reuse_addr_ = reuse_addr;
00151 }

ACE_INLINE void ACE_ATM_Params::set_rw_flag (  int    ) 
 

Set r/w flag.

Definition at line 187 of file ATM_Params.i.

References ACE_TRACE, and rw_flag_. 

00188 {
00189   ACE_TRACE ("ACE_ATM_Params::set_rw_flag");
00190   rw_flag_ = rw_flag;
00191 }

ACE_INLINE void ACE_ATM_Params::set_sock_group (  ACE_SOCK_GROUP    ) 
 

Set socket group.

Definition at line 115 of file ATM_Params.i.

References ACE_SOCK_GROUP, ACE_TRACE, and group_. 

00116 {
00117   ACE_TRACE ("ACE_ATM_Params::set_sock_group");
00118   group_ = g;
00119 }

ACE_INLINE void ACE_ATM_Params::set_type (  int    ) 
 

Set type.

Definition at line 83 of file ATM_Params.i.

References ACE_TRACE, and type_. 

00084 {
00085   ACE_TRACE ("ACE_ATM_Params::set_type");
00086   type_ = type;
00087 }

ACE_INLINE void ACE_ATM_Params::set_user_data (  Param_Udata *    ) 
 

Set user data.

Definition at line 203 of file ATM_Params.i.

References ACE_TRACE, Param_Udata, and udata_. 

00204 {
00205   ACE_TRACE ("ACE_ATM_Params::set_user_data");
00206   udata_ = udata;
00207 }

Member Data Documentation

ACE_ATM_Params::ACE_ALLOC_HOOK_DECLARE
 

Declare the dynamic allocation hooks.

Definition at line 164 of file ATM_Params.h.

const char* ACE_ATM_Params::device_ [private]
 

Device name for XTI/ATM connections.

Definition at line 189 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 183 of file ATM_Params.h.

Referenced by get_flags, and set_flags.

ACE_SOCK_GROUP ACE_ATM_Params::group_ [private]
 

Socket group used (for sockets only).

Definition at line 180 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 192 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 201 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 171 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 168 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 177 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 186 of file ATM_Params.h.

Referenced by get_reuse_addr, and set_reuse_addr.

int ACE_ATM_Params::rw_flag_ [private]
 

R/W flag for XTI/ATM connections.

Definition at line 195 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 174 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 198 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 Mon Jun 16 12:45:55 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002