#include <qmf/ConsoleSession.h>
List of all members.
Detailed Description
Definition at line 41 of file ConsoleSession.h.
Member Typedef Documentation
typedef ConsoleSessionImpl qmf::Handle< ConsoleSessionImpl >::Impl [protected, inherited] |
Constructor & Destructor Documentation
ConsoleSession A session that runs over an AMQP connection for QMF console operation.
- Parameters:
-
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] 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
- If False: Operate more flexibly with regard to use of messaging facilities [default]
Member Function Documentation
Close the session.
Once closed, the session no longer communicates on the messaging network.
getAgentCount, getAgent - Retrieve the set of agents that match the console session's agent filter.
Get the agent for the connected broker (i.e.
the agent embedded in the broker to which we have a connection).
- 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.
- Returns:
- true if handle is valid, i.e. not null.
Definition at line 42 of file Handle.h.
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.
Open the console session.
After opening the session, the domain cannot be changed.
qmf::Handle< ConsoleSessionImpl >::operator bool |
( |
| ) |
const [inline, inherited] |
Conversion to bool supports idiom if (handle) { handle->...
}
Definition at line 48 of file Handle.h.
Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
Definition at line 51 of file Handle.h.
Return the number of events pending for nextEvent.
This method will never block.
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.
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.
Member Data Documentation
The documentation for this class was generated from the following file: