A GQoS session object. More...

#include <QoS_Session_Impl.h>

Inheritance diagram for ACE_GQoS_Session:

Collaboration diagram for ACE_GQoS_Session:

Public Member Functions
	~ACE_GQoS_Session (void)
	Default destructor.
virtual int	open (ACE_INET_Addr dest_addr, ACE_Protocol_ID protocol_id)
	Open a GQoS session [dest IP, dest port, Protocol ID].
virtual int	close (void)
	Close the GQoS Session.
virtual ACE_QoS	qos (void) const
	Returns the QoS for this GQoS session.
virtual int	qos (ACE_SOCK socket, ACE_QoS_Manager qos_manager, const ACE_QoS &ace_qos)
virtual void	qos (const ACE_QoS &ace_qos)
virtual int	update_qos (void)
virtual ACE_End_Point_Type	flags (void) const
	Get/Set methods for the flags_.
virtual void	flags (const ACE_End_Point_Type flags)
virtual ACE_INET_Addr	dest_addr (void) const
	Get the destination address for this GQoS session.
virtual void	dest_addr (const ACE_INET_Addr &dest_addr)
	Set the destination address for this GQoS session.
virtual u_short	source_port (void) const
	Get the source port for this session.
virtual void	source_port (const u_short &source_port)
	Set the source port for this session.
virtual ACE_INET_Addr *	source_addr (void) const
virtual void	source_addr (ACE_INET_Addr *source_addr)
	Set the source port for this session.
virtual int	session_id (void) const
	Get the GQoS session id.
virtual void	session_id (const int session_id)
	Set the GQoS session id.
virtual ACE_HANDLE	rsvp_events_handle (void)
	Get the file descriptor of the underlying socket.
virtual void	rsvp_event_type (RSVP_Event_Type event_type)
virtual RSVP_Event_Type	rsvp_event_type (void)
	Set the RAPI event that last occured.
virtual int	version ()
	Get the RAPI event that last occured.
Static Public Attributes
static int	GQoS_session_id = 0
Private Member Functions
	ACE_GQoS_Session (void)
Friends
class	ACE_QoS_Session_Factory

Detailed Description

A GQoS session object.

This class is a GQoS (Generic QoS, an implementation of RSVP on Win2K) implementation of the ACE_QoS_Session interface.

Definition at line 165 of file QoS_Session_Impl.h.

Constructor & Destructor Documentation

ACE_GQoS_Session::~ACE_GQoS_Session ( void )

Default destructor.

Definition at line 125 of file QoS_Session_Impl.inl.

{
  ACE_TRACE ("ACE_GQoS_Session::~ACE_GQoS_Session");
}

ACE_GQoS_Session::ACE_GQoS_Session ( void ) [private]

Default constructor. Constructor is defined private so that only the friend factory can instantiate this class.

Definition at line 634 of file QoS_Session_Impl.cpp.

{
  ACE_TRACE ("ACE_GQoS_Session::ACE_GQoS_Session");
}

Member Function Documentation

int ACE_GQoS_Session::close ( void ) [virtual]

Close the GQoS Session.

Implements ACE_QoS_Session.

Definition at line 654 of file QoS_Session_Impl.cpp.

{
  // TBD.
  return 0;
}

ACE_INET_Addr ACE_GQoS_Session::dest_addr ( void ) const [virtual]

Get the destination address for this GQoS session.

Implements ACE_QoS_Session.

Definition at line 184 of file QoS_Session_Impl.inl.

{
  return this->dest_addr_;
}

void ACE_GQoS_Session::dest_addr ( const ACE_INET_Addr & dest_addr ) [virtual]

Set the destination address for this GQoS session.

Implements ACE_QoS_Session.

Definition at line 191 of file QoS_Session_Impl.inl.

{
  this->dest_addr_ = dest_addr;
}

void ACE_GQoS_Session::flags ( const ACE_End_Point_Type flags ) [virtual]

Implements ACE_QoS_Session.

Definition at line 177 of file QoS_Session_Impl.inl.

{
  this->flags_ = flags;
}

ACE_QoS_Session::ACE_End_Point_Type ACE_GQoS_Session::flags ( void ) const [virtual]

Get/Set methods for the flags_.

Implements ACE_QoS_Session.

Definition at line 170 of file QoS_Session_Impl.inl.

{
  return this->flags_;
}

int ACE_GQoS_Session::open	(	ACE_INET_Addr	dest_addr,
		ACE_Protocol_ID	protocol_id
	)			`[virtual]`

Open a GQoS session [dest IP, dest port, Protocol ID].

Implements ACE_QoS_Session.

Definition at line 641 of file QoS_Session_Impl.cpp.

{
  this->dest_addr_ = dest_addr;
  this->protocol_id_ = protocol_id;

  this->session_id_ = GQoS_session_id++;

  return 0;
}

int ACE_GQoS_Session::qos	(	ACE_SOCK *	socket,
		ACE_QoS_Manager *	qos_manager,
		const ACE_QoS &	ace_qos
	)			`[virtual]`

Set QoS for this GQoS session. The socket parameter is used to confirm if this QoS session was subscribed to by the socket.

Implements ACE_QoS_Session.

Definition at line 662 of file QoS_Session_Impl.cpp.

{

  // Confirm if the current session is one of the QoS sessions
  // subscribed to by the given socket.

  if (qos_manager->qos_session_set ().find (this) == -1)
    ACE_ERROR_RETURN ((LM_ERROR,
                       ACE_TEXT ("This QoS session was not subscribed to")
                       ACE_TEXT (" by the socket\n")),
                      -1);

  // Set the QOS according to the supplied ACE_QoS. The I/O control
  // code used under the hood is SIO_SET_QOS.

  u_long ret_bytes = 0;

  ACE_QoS qos = ace_qos;
  if (ACE_OS::ioctl (socket->get_handle (),
                     ACE_SIO_SET_QOS,
                     qos,
                     &ret_bytes) == -1)
    ACE_ERROR_RETURN ((LM_ERROR,
                       ACE_TEXT ("Error in Qos set ACE_OS::ioctl() %d\n"),
                       ret_bytes),
                      -1);
  else
    ACE_DEBUG ((LM_DEBUG,
                ACE_TEXT ("Setting QoS with ACE_OS::ioctl () succeeds\n")));

  return 0;
}

void ACE_GQoS_Session::qos ( const ACE_QoS & ace_qos ) [virtual]

Sets the QoS for this session object to ace_qos. Does not interfere with the QoS in the underlying socket. This call is useful to update the QoS object when the underlying socket QoS is being set through a mechanism other than the previous qos () method e.g. inside the dgram_mcast.subscribe () where the QoS for the socket is set through ACE_OS::join_leaf ().

Implements ACE_QoS_Session.

Definition at line 140 of file QoS_Session_Impl.inl.

{
  this->qos_ = ace_qos;
}

ACE_QoS ACE_GQoS_Session::qos ( void ) const [virtual]

Returns the QoS for this GQoS session.

Implements ACE_QoS_Session.

Definition at line 132 of file QoS_Session_Impl.inl.

{
  return this->qos_;
}

void ACE_GQoS_Session::rsvp_event_type ( ACE_QoS_Session::RSVP_Event_Type event_type ) [virtual]

Implements ACE_QoS_Session.

Definition at line 713 of file QoS_Session_Impl.cpp.

{
  this->rsvp_event_type_ = event_type;
}

ACE_QoS_Session::RSVP_Event_Type ACE_GQoS_Session::rsvp_event_type ( void ) [virtual]

Set the RAPI event that last occured.

Implements ACE_QoS_Session.

Definition at line 706 of file QoS_Session_Impl.cpp.

{
  return this->rsvp_event_type_;
}

ACE_HANDLE ACE_GQoS_Session::rsvp_events_handle ( void ) [virtual]

Get the file descriptor of the underlying socket.

Implements ACE_QoS_Session.

Definition at line 163 of file QoS_Session_Impl.inl.

{
  return 0;
}

void ACE_GQoS_Session::session_id ( const int session_id ) [virtual]

Set the GQoS session id.

Implements ACE_QoS_Session.

Definition at line 154 of file QoS_Session_Impl.inl.

{
  this->session_id_ = session_id;
}

int ACE_GQoS_Session::session_id ( void ) const [virtual]

Get the GQoS session id.

Implements ACE_QoS_Session.

Definition at line 147 of file QoS_Session_Impl.inl.

{
  return this->session_id_;
}

void ACE_GQoS_Session::source_addr ( ACE_INET_Addr * source_addr ) [virtual]

Set the source port for this session.

Implements ACE_QoS_Session.

Definition at line 217 of file QoS_Session_Impl.inl.

{
  this->src_addr_ = source_addr;
}

ACE_INET_Addr * ACE_GQoS_Session::source_addr ( void ) const [virtual]

Implements ACE_QoS_Session.

Definition at line 211 of file QoS_Session_Impl.inl.

{
  return this->src_addr_;
}

u_short ACE_GQoS_Session::source_port ( void ) const [virtual]

Get the source port for this session.

Implements ACE_QoS_Session.

Definition at line 198 of file QoS_Session_Impl.inl.

{
  return this->source_port_;
}

void ACE_GQoS_Session::source_port ( const u_short & source_port ) [virtual]

Set the source port for this session.

Implements ACE_QoS_Session.

Definition at line 205 of file QoS_Session_Impl.inl.

{
  this->source_port_ = source_port;
}

int ACE_GQoS_Session::update_qos ( void ) [virtual]

Calls the ioctl (ACE_SIO_GET_QOS). It is a mechanism of updating the QoS for this session asynchronously, as RSVP events occur.

Implements ACE_QoS_Session.

Definition at line 698 of file QoS_Session_Impl.cpp.

{
  // WSAIoctl (GET_QOS) call goes here...
  return 0;
}

int ACE_GQoS_Session::version ( void ) [virtual]

Get the RAPI event that last occured.

GQoS version.

Implements ACE_QoS_Session.

Definition at line 224 of file QoS_Session_Impl.inl.

{
  return 0;
}

Friends And Related Function Documentation

friend class ACE_QoS_Session_Factory [friend]

The factory is a friend so it can create this object through the only private constructor.

Definition at line 248 of file QoS_Session_Impl.h.

Member Data Documentation

int ACE_GQoS_Session::GQoS_session_id = 0 [static]

This is a session ID generator. It does a lot more than expected from an int!.

Definition at line 175 of file QoS_Session_Impl.h.

The documentation for this class was generated from the following files:

ACE_GQoS_Session Class Reference

Public Member Functions

Static Public Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation