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

Asynchronous commands that do not return a result will return a Completion. More...

#include <qpid/client/Completion.h>

List of all members.

Public Member Functions

 Completion (CompletionImpl *=0)
 Completion (const Completion &)
 ~Completion ()
Completionoperator= (const Completion &)
void wait ()
 Wait for the asynchronous command that returned this Completion to complete.
bool isComplete ()
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< CompletionImpl > &h)

Protected Member Functions

std::string getResult ()

Protected Attributes

Impl * impl

Detailed Description

Asynchronous commands that do not return a result will return a Completion.

You can use the completion to wait for that specific command to complete.

See also:
TypedResult

Definition at line 44 of file Completion.h.


Constructor & Destructor Documentation

qpid::client::Completion::Completion ( CompletionImpl *  = 0)
qpid::client::Completion::Completion ( const Completion )
qpid::client::Completion::~Completion ( )

Member Function Documentation

std::string qpid::client::Completion::getResult ( ) [protected]
bool qpid::client::Completion::isComplete ( )
QPID_CLIENT_INLINE_EXTERN bool qpid::client::Handle< CompletionImpl >::isNull ( ) const [inline, inherited]
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.

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

Definition at line 43 of file Handle.h.

QPID_CLIENT_INLINE_EXTERN qpid::client::Handle< CompletionImpl >::operator bool ( ) const [inline, inherited]

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

}

Definition at line 49 of file Handle.h.

QPID_CLIENT_INLINE_EXTERN bool qpid::client::Handle< CompletionImpl >::operator! ( ) const [inline, inherited]

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

Definition at line 52 of file Handle.h.

Completion& qpid::client::Completion::operator= ( const Completion )
void qpid::client::Handle< CompletionImpl >::swap ( Handle< CompletionImpl > &  h) [inline, inherited]

Definition at line 54 of file Handle.h.

void qpid::client::Completion::wait ( )

Wait for the asynchronous command that returned this Completion to complete.

Exceptions:
Ifthe command returns an error.

Member Data Documentation

Impl* qpid::client::Handle< CompletionImpl >::impl [protected, inherited]

Definition at line 64 of file Handle.h.


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