Apache Qpid C++ API
Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation

qpid::client::Handle< T > Class Template Reference

A handle is like a pointer: it points to some underlying object. More...

#include <Handle.h>

Inherited by qpid::client::Subscription.

List of all members.

Public Member Functions

 ~Handle ()
 Handle (const Handle &)
Handleoperator= (const Handle &)
bool isValid () const
bool isNull () const
 operator bool () const
bool operator! () const
void swap (Handle< T > &)

Protected Member Functions

 Handle (T *=0)

Protected Attributes

T * impl


Detailed Description

template<class T>
class qpid::client::Handle< T >

A handle is like a pointer: it points to some underlying object.

Handles can be null, like a 0 pointer. Use isValid(), isNull() or the implicit conversion to bool to test for a null handle.

Definition at line 35 of file Handle.h.


Constructor & Destructor Documentation

template<class T>
qpid::client::Handle< T >::~Handle (  ) 

Definition at line 39 of file HandlePrivate.h.

References qpid::client::Handle< T >::impl.

template<class T>
qpid::client::Handle< T >::Handle ( const Handle< T > &   ) 

Definition at line 42 of file HandlePrivate.h.

References qpid::client::Handle< T >::impl.

template<class T>
qpid::client::Handle< T >::Handle ( T *  = 0  )  [protected]

Definition at line 36 of file HandlePrivate.h.

References qpid::client::Handle< T >::impl.


Member Function Documentation

template<class T>
bool qpid::client::Handle< T >::isNull (  )  const [inline]

Returns:
true if handle is null. It is an error to call any function on a null handle.

Definition at line 45 of file Handle.h.

template<class T>
bool qpid::client::Handle< T >::isValid (  )  const [inline]

Returns:
true if handle is valid, i.e. not null.

Definition at line 42 of file Handle.h.

template<class T>
qpid::client::Handle< T >::operator bool (  )  const [inline]

Definition at line 47 of file Handle.h.

template<class T>
bool qpid::client::Handle< T >::operator! (  )  const [inline]

Definition at line 48 of file Handle.h.

template<class T>
Handle& qpid::client::Handle< T >::operator= ( const Handle< T > &   ) 

template<class T>
void qpid::client::Handle< T >::swap ( Handle< T > &   ) 

Definition at line 48 of file HandlePrivate.h.

References qpid::client::Handle< T >::impl.


Member Data Documentation

template<class T>
T* qpid::client::Handle< T >::impl [protected]

Definition at line 54 of file Handle.h.

Referenced by qpid::client::HandlePrivate< T >::get(), qpid::client::HandleAccess< T >::getImpl(), qpid::client::Handle< T >::Handle(), qpid::client::Handle< qpid::client::SubscriptionImpl >::isNull(), qpid::client::Handle< qpid::client::SubscriptionImpl >::isValid(), qpid::client::Handle< qpid::client::SubscriptionImpl >::operator bool(), qpid::client::Handle< qpid::client::SubscriptionImpl >::operator!(), qpid::client::Handle< T >::swap(), and qpid::client::Handle< T >::~Handle().


The documentation for this class was generated from the following files:
Qpid C++ API Reference
Generated on Tue Dec 8 15:39:37 2009 for Qpid C++ Client API by doxygen 1.4.7