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

Apache Qpid Documentation

qpid::client::Completion Class Reference

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

#include <qpid/client/Completion.h>

Inherits qpid::client::Handle< CompletionImpl >.

Inherited by qpid::client::TypedResult< T >.

List of all members.

Public Member Functions
	Completion (CompletionImpl *=0)
	Completion (const Completion &)
	~Completion ()
Completion &	operator= (const Completion &)
void	wait ()
	Wait for the asynchronous command that returned this Completion to complete.
bool	isComplete ()
bool	isValid () const
bool	isNull () const
	operator bool () const
	Conversion to bool supports idiom if (handle) { handle->.
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]

Referenced by qpid::client::TypedResult< T >::get().

bool qpid::client::Completion::isComplete

(

)

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.

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::Handle< CompletionImpl >::operator bool

(

)

const [inline, inherited]

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

.. }

Definition at line 49 of file Handle.h.

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:

If

the 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/client/Completion.h

---