Qpid C++ Messaging API  0.22
qpid::messaging::Handle Class Reference

#include <Handle.h>

List of all members.

Public Member Functions

QPID_MESSAGING_INLINE_EXTERN bool isValid () const
QPID_MESSAGING_INLINE_EXTERN bool isNull () const
QPID_MESSAGING_INLINE_EXTERN operator bool () const
QPID_MESSAGING_INLINE_EXTERN bool operator! () const
void swap (Handle< T > &h)

Protected Types

typedef T Impl

Protected Member Functions

QPID_MESSAGING_INLINE_EXTERN Handle ()
QPID_MESSAGING_EXTERN Handle (const Handle &)
QPID_MESSAGING_EXTERN Handleoperator= (const Handle &)

Protected Attributes

Implimpl

Friends

class PrivateImplRef< T >

Detailed Description

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.


Member Typedef Documentation

typedef T qpid::messaging::Handle::Impl [protected]

Constructor & Destructor Documentation

QPID_MESSAGING_INLINE_EXTERN qpid::messaging::Handle::Handle ( ) [inline, protected]
QPID_MESSAGING_EXTERN qpid::messaging::Handle::Handle ( const Handle ) [protected]

Member Function Documentation

QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle::isNull ( ) const [inline]
Returns:
true if handle is null. It is an error to call any function on a null handle.
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle::isValid ( ) const [inline]
Returns:
true if handle is valid, i.e. not null.
QPID_MESSAGING_INLINE_EXTERN qpid::messaging::Handle::operator bool ( ) const [inline]

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

QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle::operator! ( ) const [inline]

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

QPID_MESSAGING_EXTERN Handle& qpid::messaging::Handle::operator= ( const Handle ) [protected]
void qpid::messaging::Handle::swap ( Handle< T > &  h) [inline]

Friends And Related Function Documentation

friend class PrivateImplRef< T > [friend]

Member Data Documentation


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