Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
qpid::client::Handle< T > Class Template Reference

A handle is like a pointer: refers to an underlying implementation object. More...

#include <qpid/client/Handle.h>

List of all members.

Public Member Functions

QPID_CLIENT_INLINE_EXTERN bool isValid () const
QPID_CLIENT_INLINE_EXTERN bool isNull () const
QPID_CLIENT_INLINE_EXTERN operator bool () const
 Conversion to bool supports idiom if (handle) { handle->...
QPID_CLIENT_INLINE_EXTERN bool operator! () const
 Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
void swap (Handle< T > &h)

Protected Types

typedef T Impl

Protected Member Functions

QPID_CLIENT_INLINE_EXTERN Handle ()
 Handle (const Handle &)
Handleoperator= (const Handle &)

Protected Attributes

Implimpl

Detailed Description

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

A handle is like a pointer: refers to an underlying implementation object.

Copying the handle does not copy the object.

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

Definition at line 39 of file Handle.h.


Member Typedef Documentation

template<class T>
typedef T qpid::client::Handle< T >::Impl [protected]

Definition at line 57 of file Handle.h.


Constructor & Destructor Documentation

template<class T>
QPID_CLIENT_INLINE_EXTERN qpid::client::Handle< T >::Handle ( ) [inline, protected]

Definition at line 58 of file Handle.h.

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

Member Function Documentation

template<class T>
QPID_CLIENT_INLINE_EXTERN 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 46 of file Handle.h.

template<class T>
QPID_CLIENT_INLINE_EXTERN bool qpid::client::Handle< T >::isValid ( ) const [inline]
Returns:
true if handle is valid, i.e. not null.

Definition at line 43 of file Handle.h.

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

Conversion to bool supports idiom if (handle) { handle->...

}

Definition at line 49 of file Handle.h.

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

Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.

Definition at line 52 of file Handle.h.

template<class T>
Handle& qpid::client::Handle< T >::operator= ( const Handle< T > &  ) [protected]
template<class T>
void qpid::client::Handle< T >::swap ( Handle< T > &  h) [inline]

Definition at line 54 of file Handle.h.


Member Data Documentation

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

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

Qpid C++ API Reference
Generated on Mon Aug 22 2011 for Qpid C++ Client API by doxygen 1.7.4