#include <qmf/Agent.h>
List of all members.
Detailed Description
Definition at line 45 of file Agent.h.
Member Typedef Documentation
Constructor & Destructor Documentation
qmf::Agent::Agent |
( |
AgentImpl * |
impl = 0 | ) |
|
qmf::Agent::Agent |
( |
const Agent & |
| ) |
|
Member Function Documentation
Create a subscription to this agent.
std::string qmf::Agent::getInstance |
( |
| ) |
const |
std::string qmf::Agent::getName |
( |
| ) |
const |
const std::string& qmf::Agent::getPackage |
( |
uint32_t |
| ) |
const |
uint32_t qmf::Agent::getPackageCount |
( |
| ) |
const |
Get the list of schema packages exposed by the agent.
getPackageCount returns the number of packages exposed. getPackage returns the name of the package by index (0..package-count)
Note that both of these calls are synchronous and non-blocking. They only return locally cached data and will not send any messages to the remote agent. Use querySchema[Async] to get the latest schema information from the remote agent.
std::string qmf::Agent::getProduct |
( |
| ) |
const |
Get detailed schema information for a specified schema ID.
This call will return cached information if it is available. If not, it will send a query message to the remote agent and block waiting for a response. The timeout argument specifies the maximum time to wait for a response from the agent.
uint32_t qmf::Agent::getSchemaIdCount |
( |
const std::string & |
| ) |
const |
Get the list of schema identifiers for a particular package.
getSchemaIdCount returns the number of IDs in the indicates package. getSchemaId returns the SchemaId by index (0..schema-id-count)
Note that both of these calls are synchronous and non-blocking. They only return locally cached data and will not send any messages to the remote agent. Use querySchema[Async] to get the latest schema information from the remote agent.
std::string qmf::Agent::getVendor |
( |
| ) |
const |
QMF_INLINE_EXTERN bool qmf::Handle< AgentImpl >::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.
QMF_INLINE_EXTERN bool qmf::Handle< AgentImpl >::isValid |
( |
| ) |
const [inline, inherited] |
- Returns:
- true if handle is valid, i.e. not null.
Definition at line 42 of file Handle.h.
QMF_INLINE_EXTERN qmf::Handle< AgentImpl >::operator bool |
( |
| ) |
const [inline, inherited] |
Conversion to bool supports idiom if (handle) { handle->...
}
Definition at line 48 of file Handle.h.
QMF_INLINE_EXTERN bool qmf::Handle< AgentImpl >::operator! |
( |
| ) |
const [inline, inherited] |
Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
Definition at line 51 of file Handle.h.
uint32_t qmf::Agent::queryAsync |
( |
const std::string & |
| ) |
|
Query the agent for a list of schema classes that it exposes.
This operation comes in both synchronous (blocking) and asynchronous flavors.
This method will typically be used after receiving an AGENT_SCHEMA_UPDATE event from the console session. It may also be used on a newly discovered agent to learn what schemata are exposed.
querySchema returns a ConsoleEvent that contains a list of SchemaId objects exposed by the agent. This list is cached locally and can be locally queried using getPackage[Count] and getSchemaId[Count].
uint32_t qmf::Agent::querySchemaAsync |
( |
| ) |
|
Member Data Documentation
The documentation for this class was generated from the following file: