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

Returned by asynchronous commands that return a result. More...

#include <qpid/client/TypedResult.h>

Public Member Functions
	TypedResult (const Completion &c)
T &	get ()
	Wait for the asynchronous command that returned this TypedResult to complete and return its result. More...
void	wait ()
	Wait for the asynchronous command that returned this Completion to complete. More...
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->... More...
QPID_CLIENT_INLINE_EXTERN bool	operator! () const
	Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }. More...
void	swap (Handle< CompletionImpl > &h)

Protected Member Functions
std::string	getResult ()

Protected Attributes
Impl *	impl

Detailed Description

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

Returned by asynchronous commands that return a result.

You can use get() to wait for completion and get the result value.

Definition at line 36 of file TypedResult.h.

Constructor & Destructor Documentation

template<class T >

qpid::client::TypedResult< T >::TypedResult ( const Completion &  c )

inline

Definition at line 43 of file TypedResult.h.

Member Function Documentation

template<class T >

T& qpid::client::TypedResult< T >::get ( )

inline

Wait for the asynchronous command that returned this TypedResult to complete and return its result.

Returns

The result returned by the command.

Exceptions

If	the command returns an error, get() throws an exception.

Definition at line 53 of file TypedResult.h.

References qpid::framing::StructHelper::decode(), and qpid::client::Completion::getResult().

std::string qpid::client::Completion::getResult ( )

protectedinherited

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

bool qpid::client::Completion::isComplete ( )

inherited

QPID_CLIENT_INLINE_EXTERN bool qpid::client::Handle< CompletionImpl >::isNull ( ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

Definition at line 52 of file Handle.h.

void qpid::client::Handle< CompletionImpl >::swap ( Handle< CompletionImpl > &  h )

inlineinherited

Definition at line 54 of file Handle.h.

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

inherited

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

protectedinherited

Definition at line 64 of file Handle.h.

---

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

• qpid/client/TypedResult.h