Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET | Apache Qpid Documentation |
#include <qmf/ConsoleSession.h>
Inherits qmf::Handle< ConsoleSessionImpl >.
Public Member Functions | |
ConsoleSession (ConsoleSessionImpl *impl=0) | |
ConsoleSession (const ConsoleSession &) | |
ConsoleSession & | operator= (const ConsoleSession &) |
~ConsoleSession () | |
ConsoleSession (qpid::messaging::Connection &conn, const std::string &options="") | |
ConsoleSession A session that runs over an AMQP connection for QMF console operation. | |
void | setDomain (const std::string &domain) |
setDomain - Change the QMF domain that this console will operate in. | |
void | setAgentFilter (const std::string &filter) |
void | open () |
Open the console session. | |
void | close () |
Close the session. | |
bool | nextEvent (ConsoleEvent &outEvent, qpid::messaging::Duration timeout=qpid::messaging::Duration::FOREVER) |
Get the next event from the console session. | |
int | pendingEvents () const |
Return the number of events pending for nextEvent. | |
uint32_t | getAgentCount () const |
getAgentCount, getAgent - Retrieve the set of agents that match the console session's agent filter. | |
Agent | getAgent (uint32_t agentIndex) const |
Agent | getConnectedBrokerAgent () const |
Get the agent for the connected broker (i.e. | |
Subscription | subscribe (const Query &query, const std::string &agentFilter="", const std::string &options="") |
Create a subscription that involves a subset of the known agents. | |
Subscription | subscribe (const std::string &query, const std::string &agentFilter="", const std::string &options="") |
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 | |
Impl * | impl |
Definition at line 41 of file ConsoleSession.h.
typedef ConsoleSessionImpl qmf::Handle< ConsoleSessionImpl >::Impl [protected, inherited] |
qmf::ConsoleSession::ConsoleSession | ( | ConsoleSessionImpl * | impl = 0 |
) |
qmf::ConsoleSession::ConsoleSession | ( | const ConsoleSession & | ) |
qmf::ConsoleSession::~ConsoleSession | ( | ) |
qmf::ConsoleSession::ConsoleSession | ( | qpid::messaging::Connection & | conn, | |
const std::string & | options = "" | |||
) |
ConsoleSession A session that runs over an AMQP connection for QMF console operation.
connection | - An opened qpid::messaging::Connection | |
options | - An optional string containing options |
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] listen-on-direct:{True,False} - If True: Listen on legacy direct-exchange address for backward compatibility [default] If False: Listen only on the routable direct address strict-security:{True,False} - If True: Cooperate with the broker to enforce strict access control to the network
void qmf::ConsoleSession::close | ( | ) |
Close the session.
Once closed, the session no longer communicates on the messaging network.
uint32_t qmf::ConsoleSession::getAgentCount | ( | ) | const |
getAgentCount, getAgent - Retrieve the set of agents that match the console session's agent filter.
Agent qmf::ConsoleSession::getConnectedBrokerAgent | ( | ) | const |
Get the agent for the connected broker (i.e.
the agent embedded in the broker to which we have a connection).
bool qmf::Handle< ConsoleSessionImpl >::isNull | ( | ) | const [inline, inherited] |
bool qmf::Handle< ConsoleSessionImpl >::isValid | ( | ) | const [inline, inherited] |
bool qmf::ConsoleSession::nextEvent | ( | ConsoleEvent & | outEvent, | |
qpid::messaging::Duration | timeout = qpid::messaging::Duration::FOREVER | |||
) |
Get the next event from the console session.
Events represent actions that must be acted upon by the console application. This method blocks for up to the timeout if there are no events to be handled. This method will typically be the focus of the console application's main execution loop. If the timeout is set to Duration::IMMEDIATE, the call will not block.
void qmf::ConsoleSession::open | ( | ) |
Open the console session.
After opening the session, the domain cannot be changed.
qmf::Handle< ConsoleSessionImpl >::operator bool | ( | ) | const [inline, inherited] |
bool qmf::Handle< ConsoleSessionImpl >::operator! | ( | ) | const [inline, inherited] |
ConsoleSession& qmf::ConsoleSession::operator= | ( | const ConsoleSession & | ) |
int qmf::ConsoleSession::pendingEvents | ( | ) | const |
Return the number of events pending for nextEvent.
This method will never block.
void qmf::ConsoleSession::setAgentFilter | ( | const std::string & | filter | ) |
void qmf::ConsoleSession::setDomain | ( | const std::string & | domain | ) |
setDomain - Change the QMF domain that this console will operate in.
If this is not called, the domain will be "default". Agents in a domain can be seen only by consoles in the same domain. This must be called prior to opening the console session.
Subscription qmf::ConsoleSession::subscribe | ( | const std::string & | query, | |
const std::string & | agentFilter = "" , |
|||
const std::string & | options = "" | |||
) |
Subscription qmf::ConsoleSession::subscribe | ( | const Query & | query, | |
const std::string & | agentFilter = "" , |
|||
const std::string & | options = "" | |||
) |
Create a subscription that involves a subset of the known agents.
The set of known agents is defined by the session's agent-filter (see setAgentFilter). The agentFilter argument to the subscribe method is used to further refine the set of agents. If agentFilter is the empty string (i.e. match-all) the subscription will involve all known agents. If agentFilter is non-empty, it will be applied only to the set of known agents. A subscription cannot be created that involves an agent not known by the session.
void qmf::Handle< ConsoleSessionImpl >::swap | ( | Handle< ConsoleSessionImpl > & | h | ) | [inline, inherited] |
Impl* qmf::Handle< ConsoleSessionImpl >::impl [protected, inherited] |