PortableServer::Servant_var Class Reference

Provides a type safe counted reference to servants. More...

#include <Servant_var.h>

List of all members.

Public Types
typedef T	servant_type
Public Member Functions
	Servant_var (T *p=0)
	Constructor. Assumes ownership of p.
	Servant_var (Servant_var< T > const &rhs)
	Copy constructor. Adds reference to rhs.
Servant_var< T > &	operator= (Servant_var< T > const &rhs)
	Assignment operator. Adds reference to rhs.
	~Servant_var (void)
Servant_var< T > &	operator= (T *p)
	Assignment operator. Assumes ownership of p.
T *	operator-> () const
	Smart pointer operator-> provides access to the underlying object.
T const &	operator* () const
	Dereference the underlying object.
T &	operator* ()
	Dereference the underlying object.
	operator void const * () const
T *	in () const
	As an IN parameter.
T *&	inout ()
	As an INOUT parameter.
T *&	out ()
	As an OUT parameter.
T *	_retn ()
void	swap (Servant_var< T > &rhs)
Static Public Member Functions
static T *	_duplicate (T *)
	Increment the reference count and return the servant.
Private Attributes
T *	ptr_

---

Detailed Description

Provides a type safe counted reference to servants.

Author:

Jody Hagins

Todo:

Life would be much easier if _add_ref() and _remove_ref() had throw specs of "throw ()", that can be hidden in static methods though.

---

Member Typedef Documentation

typedef T PortableServer::Servant_var::servant_type

---

Constructor & Destructor Documentation

PortableServer::Servant_var::Servant_var

(

T *

p = 0

)

Constructor. Assumes ownership of p.

PortableServer::Servant_var::Servant_var

(

Servant_var< T > const &

rhs

)

Copy constructor. Adds reference to rhs.

PortableServer::Servant_var::~Servant_var

(

void

)

Destructor. Removes a reference from the underlying object, possibly destroying it. This destructor doesn't throw exceptions.

---

Member Function Documentation

T * PortableServer::Servant_var::_duplicate

(

T *

p

)

[static]

Increment the reference count and return the servant.

It is safe to pass in a null pointer, the pointer is simply returned in that case.

Todo:

We might want to catch all (potential) exceptions in _add_ref().

Todo:

It might be useful to add a _release() method that handles any potential exceptions...

T * PortableServer::Servant_var::_retn

(

void

)

Return a pointer to the underlying object, and this counted reference will no longer own the object.

T * PortableServer::Servant_var::in

(

void

)

const

As an IN parameter.

T *& PortableServer::Servant_var::inout

(

void

)

As an INOUT parameter.

PortableServer::Servant_var::operator void const *

(

)

const

Return a void pointer to the underlying object. This allows it to be used in conditional code and tested against 0.

T const & PortableServer::Servant_var::operator*

(

)

const

Dereference the underlying object.

T & PortableServer::Servant_var::operator*

(

)

Dereference the underlying object.

T * PortableServer::Servant_var::operator->

(

)

const

Smart pointer operator-> provides access to the underlying object.

PortableServer::Servant_var< T > & PortableServer::Servant_var::operator=

(

Servant_var< T > const &

rhs

)

Assignment operator. Adds reference to rhs.

PortableServer::Servant_var< T > & PortableServer::Servant_var::operator=

(

T *

p

)

Assignment operator. Assumes ownership of p.

T *& PortableServer::Servant_var::out

(

void

)

As an OUT parameter.

void PortableServer::Servant_var::swap

(

Servant_var< T > &

rhs

)

Swap the contents of a Servant_var<T> with another Servant_var<T> Non-throwing swap operation. Often used to implement strong exception safety.

---

Member Data Documentation

T* PortableServer::Servant_var::ptr_ [private]

---

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

• Servant_var.h
• Servant_var.cpp
• Servant_var.inl