Qpid C++ API Reference
Generated on Tue Nov 23 19:30:58 2010 for Qpid C++ Client API by doxygen 1.6.1

qmf::ConsoleSession Class Reference

#include <qmf/ConsoleSession.h>

List of all members.

Public Member Functions

 ConsoleSession (ConsoleSessionImpl *impl=0)
 ConsoleSession (const ConsoleSession &)
ConsoleSessionoperator= (const ConsoleSession &)
 ~ConsoleSession ()
 ConsoleSession (qpid::messaging::Connection &, const std::string &options="")
 ConsoleSession A session that runs over an AMQP connection for QMF console operation.
void setDomain (const std::string &)
void setAgentFilter (const std::string &)
void open ()
void close ()
bool nextEvent (ConsoleEvent &, qpid::messaging::Duration timeout=qpid::messaging::Duration::FOREVER)
uint32_t getAgentCount () const
Agent getAgent (uint32_t) const
Agent getConnectedBrokerAgent () const
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< ConsoleSessionImpl > &h)

Protected Types

typedef ConsoleSessionImpl Impl

Protected Attributes

Implimpl

Detailed Description

Definition at line 40 of file ConsoleSession.h.


Member Typedef Documentation

typedef ConsoleSessionImpl qmf::Handle< ConsoleSessionImpl >::Impl [protected, inherited]

Definition at line 56 of file Handle.h.


Constructor & Destructor Documentation

qmf::ConsoleSession::ConsoleSession ( ConsoleSessionImpl *  impl = 0  ) 
qmf::ConsoleSession::ConsoleSession ( const ConsoleSession  ) 
qmf::ConsoleSession::~ConsoleSession (  ) 
qmf::ConsoleSession::ConsoleSession ( qpid::messaging::Connection ,
const std::string &  options = "" 
)

ConsoleSession A session that runs over an AMQP connection for QMF console operation.

Parameters:
connection - An opened qpid::messaging::Connection
options - An optional string containing options

The options string is of the form "{key:value,key:value}". The following keys are supported:

domain:NAME - QMF Domain to join [default: "default"] max-agent-age:N - Maximum time, in minutes, that we will tolerate not hearing from an agent before deleting it [default: 5]


Member Function Documentation

void qmf::ConsoleSession::close (  ) 
Agent qmf::ConsoleSession::getAgent ( uint32_t   )  const
uint32_t qmf::ConsoleSession::getAgentCount (  )  const
Agent qmf::ConsoleSession::getConnectedBrokerAgent (  )  const
bool qmf::Handle< ConsoleSessionImpl >::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 45 of file Handle.h.

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

Definition at line 42 of file Handle.h.

bool qmf::ConsoleSession::nextEvent ( ConsoleEvent ,
qpid::messaging::Duration  timeout = qpid::messaging::Duration::FOREVER 
)
void qmf::ConsoleSession::open (  ) 
qmf::Handle< ConsoleSessionImpl >::operator bool (  )  const [inline, inherited]

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

.. }

Definition at line 48 of file Handle.h.

bool qmf::Handle< ConsoleSessionImpl >::operator! (  )  const [inline, inherited]

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

Definition at line 51 of file Handle.h.

ConsoleSession& qmf::ConsoleSession::operator= ( const ConsoleSession  ) 
void qmf::ConsoleSession::setAgentFilter ( const std::string &   ) 
void qmf::ConsoleSession::setDomain ( const std::string &   ) 
void qmf::Handle< ConsoleSessionImpl >::swap ( Handle< ConsoleSessionImpl > &  h  )  [inline, inherited]

Definition at line 53 of file Handle.h.


Member Data Documentation

Impl* qmf::Handle< ConsoleSessionImpl >::impl [protected, inherited]

Definition at line 63 of file Handle.h.


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

Qpid C++ API Reference
Generated on Tue Nov 23 19:30:58 2010 for Qpid C++ Client API by doxygen 1.6.1