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

ACE_QoS_Params Class Reference

Wrapper class that simplifies the information passed to the QoS enabled <ACE_OS::connect> and <ACE_OS::join_leaf> methods. More...

#include <OS_QoS.h>

Collaboration diagram for ACE_QoS_Params:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_QoS_Params (iovec *caller_data=0, iovec *callee_data=0, ACE_QoS *socket_qos=0, ACE_QoS *group_socket_qos=0, unsigned long flags=0)
iovec * caller_data (void) const
 Get caller data.

void caller_data (iovec *)
 Set caller data.

iovec * callee_data (void) const
 Get callee data.

void callee_data (iovec *)
 Set callee data.

ACE_QoS * socket_qos (void) const
 Get socket qos.

void socket_qos (ACE_QoS *)
 Set socket qos.

ACE_QoS * group_socket_qos (void) const
 Get group socket qos.

void group_socket_qos (ACE_QoS *)
 Set group socket qos.

unsigned long flags (void) const
 Get flags.

void flags (unsigned long)
 Set flags.


Private Attributes

iovec * caller_data_
iovec * callee_data_
ACE_QoS * socket_qos_
ACE_QoS * group_socket_qos_
unsigned long flags_
 Flags that indicate if we're a sender, receiver, or both.

Detailed Description

Wrapper class that simplifies the information passed to the QoS enabled <ACE_OS::connect> and <ACE_OS::join_leaf> methods.

Definition at line 314 of file OS_QoS.h.

Constructor & Destructor Documentation

ACE_QoS_Params::ACE_QoS_Params (  iovec *  caller_data = 0,
iovec *  callee_data = 0,
ACE_QoS *  socket_qos = 0,
ACE_QoS *  group_socket_qos = 0,
unsigned long  flags = 0
) 
 

Initialize the data members. The is a pointer to the user data that is to be transferred to the peer during connection establishment. The is a pointer to the user data that is to be transferred back from the peer during connection establishment. The_<socket_qos> is a pointer to the flow specifications for the socket, one for each direction. The is a pointer to the flow speicfications for the socket group, if applicable. The_<flags> indicate if we're a sender, receiver, or both.

Definition at line 372 of file OS_QoS.cpp. 

00377   : caller_data_ (caller_data),
00378     callee_data_ (callee_data),
00379     socket_qos_ (socket_qos),
00380     group_socket_qos_ (group_socket_qos),
00381     flags_ (flags)
00382 {
00383 }

Member Function Documentation

void ACE_QoS_Params::callee_data (  iovec *   ) 
 

Set callee data.

Definition at line 404 of file OS_QoS.cpp.

References callee_data_. 

00405 {
00406   this->callee_data_ = cd;
00407 }

iovec * ACE_QoS_Params::callee_data (  void   )  const
 

Get callee data.

Definition at line 398 of file OS_QoS.cpp.

References callee_data_.

Referenced by ACE_OS::connect(), and ACE_OS::join_leaf(). 

00399 {
00400   return this->callee_data_;
00401 }

void ACE_QoS_Params::caller_data (  iovec *   ) 
 

Set caller data.

Definition at line 392 of file OS_QoS.cpp.

References caller_data_. 

00393 {
00394   this->caller_data_ = cd;
00395 }

iovec * ACE_QoS_Params::caller_data (  void   )  const
 

Get caller data.

Definition at line 386 of file OS_QoS.cpp.

References caller_data_.

Referenced by ACE_OS::connect(), and ACE_OS::join_leaf(). 

00387 {
00388   return this->caller_data_;
00389 }

void ACE_QoS_Params::flags (  unsigned  long  ) 
 

Set flags.

Definition at line 440 of file OS_QoS.cpp. 

00441 {
00442   this->flags_ = f;
00443 }

unsigned long ACE_QoS_Params::flags (  void   )  const
 

Get flags.

Definition at line 434 of file OS_QoS.cpp.

Referenced by ACE_OS::join_leaf(). 

00435 {
00436   return this->flags_;
00437 }

void ACE_QoS_Params::group_socket_qos (  ACE_QoS *   ) 
 

Set group socket qos.

Definition at line 428 of file OS_QoS.cpp.

References group_socket_qos_. 

00429 {
00430   this->group_socket_qos_ = gsq;
00431 }

ACE_QoS * ACE_QoS_Params::group_socket_qos (  void   )  const
 

Get group socket qos.

Definition at line 422 of file OS_QoS.cpp.

References group_socket_qos_.

Referenced by ACE_OS::connect(), and ACE_OS::join_leaf(). 

00423 {
00424   return this->group_socket_qos_;
00425 }

void ACE_QoS_Params::socket_qos (  ACE_QoS *   ) 
 

Set socket qos.

Definition at line 416 of file OS_QoS.cpp.

References socket_qos_. 

00417 {
00418   this->socket_qos_ = sq;
00419 }

ACE_QoS * ACE_QoS_Params::socket_qos (  void   )  const
 

Get socket qos.

Definition at line 410 of file OS_QoS.cpp.

References socket_qos_.

Referenced by ACE_OS::connect(), and ACE_OS::join_leaf(). 

00411 {
00412   return this->socket_qos_;
00413 }

Member Data Documentation

iovec* ACE_QoS_Params::callee_data_ [private]
 

A pointer to the user data that is to be transferred back from the peer during connection establishment.

Definition at line 371 of file OS_QoS.h.

Referenced by callee_data().

iovec* ACE_QoS_Params::caller_data_ [private]
 

A pointer to the user data that is to be transferred to the peer during connection establishment.

Definition at line 367 of file OS_QoS.h.

Referenced by caller_data().

unsigned long ACE_QoS_Params::flags_ [private]
 

Flags that indicate if we're a sender, receiver, or both.

Definition at line 382 of file OS_QoS.h.

ACE_QoS* ACE_QoS_Params::group_socket_qos_ [private]
 

A pointer to the flow speicfications for the socket group, if applicable.

Definition at line 379 of file OS_QoS.h.

Referenced by group_socket_qos().

ACE_QoS* ACE_QoS_Params::socket_qos_ [private]
 

A pointer to the flow speicfications for the socket, one for each direction.

Definition at line 375 of file OS_QoS.h.

Referenced by socket_qos().

The documentation for this class was generated from the following files:
Generated on Sun Jan 27 12:56:32 2008 for ACE by doxygen 1.3.6