Qpid Management Framework  0.26
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
qmf::Agent Class Reference

#include <Agent.h>

Inheritance diagram for qmf::Agent:
Collaboration diagram for qmf::Agent:

Public Member Functions

QMF_EXTERN Agent (AgentImpl *impl=0)
 
QMF_EXTERN Agent (const Agent &)
 
QMF_EXTERN Agentoperator= (const Agent &)
 
QMF_EXTERN ~Agent ()
 
QMF_EXTERN std::string getName () const
 
QMF_EXTERN uint32_t getEpoch () const
 
QMF_EXTERN std::string getVendor () const
 
QMF_EXTERN std::string getProduct () const
 
QMF_EXTERN std::string getInstance () const
 
QMF_EXTERN const
qpid::types::Variant & 
getAttribute (const std::string &) const
 
QMF_EXTERN const
qpid::types::Variant::Map & 
getAttributes () const
 
QMF_EXTERN ConsoleEvent query (const Query &, qpid::messaging::Duration timeout=qpid::messaging::Duration::MINUTE)
 
QMF_EXTERN ConsoleEvent query (const std::string &, qpid::messaging::Duration timeout=qpid::messaging::Duration::MINUTE)
 
QMF_EXTERN uint32_t queryAsync (const Query &)
 
QMF_EXTERN uint32_t queryAsync (const std::string &)
 
QMF_EXTERN ConsoleEvent callMethod (const std::string &, const qpid::types::Variant::Map &, const DataAddr &, qpid::messaging::Duration timeout=qpid::messaging::Duration::MINUTE)
 
QMF_EXTERN uint32_t callMethodAsync (const std::string &, const qpid::types::Variant::Map &, const DataAddr &)
 
QMF_EXTERN ConsoleEvent querySchema (qpid::messaging::Duration timeout=qpid::messaging::Duration::MINUTE)
 
QMF_EXTERN uint32_t querySchemaAsync ()
 
QMF_EXTERN uint32_t getPackageCount () const
 
QMF_EXTERN const std::string & getPackage (uint32_t) const
 
QMF_EXTERN uint32_t getSchemaIdCount (const std::string &) const
 
QMF_EXTERN SchemaId getSchemaId (const std::string &, uint32_t) const
 
QMF_EXTERN Schema getSchema (const SchemaId &, qpid::messaging::Duration timeout=qpid::messaging::Duration::MINUTE)
 
- Public Member Functions inherited from qmf::Handle< AgentImpl >
QMF_INLINE_EXTERN bool isValid () const
 
QMF_INLINE_EXTERN bool isNull () const
 
QMF_INLINE_EXTERN operator bool () const
 
QMF_INLINE_EXTERN bool operator! () const
 
void swap (Handle< AgentImpl > &h)
 

Friends

class qmf::PrivateImplRef< Agent >
 
struct AgentImplAccess
 

Additional Inherited Members

- Protected Types inherited from qmf::Handle< AgentImpl >
typedef AgentImpl Impl
 
- Protected Member Functions inherited from qmf::Handle< AgentImpl >
QMF_INLINE_EXTERN Handle ()
 
QMF_EXTERN Handle (const Handle &)
 
QMF_EXTERN Handleoperator= (const Handle &)
 
- Protected Attributes inherited from qmf::Handle< AgentImpl >
Implimpl
 

Constructor & Destructor Documentation

QMF_EXTERN qmf::Agent::Agent ( AgentImpl *  impl = 0)
QMF_EXTERN qmf::Agent::Agent ( const Agent )
QMF_EXTERN qmf::Agent::~Agent ( )

Member Function Documentation

QMF_EXTERN ConsoleEvent qmf::Agent::callMethod ( const std::string &  ,
const qpid::types::Variant::Map &  ,
const DataAddr ,
qpid::messaging::Duration  timeout = qpid::messaging::Duration::MINUTE 
)

Create a subscription to this agent

QMF_EXTERN uint32_t qmf::Agent::callMethodAsync ( const std::string &  ,
const qpid::types::Variant::Map &  ,
const DataAddr  
)
QMF_EXTERN const qpid::types::Variant& qmf::Agent::getAttribute ( const std::string &  ) const
QMF_EXTERN const qpid::types::Variant::Map& qmf::Agent::getAttributes ( ) const
QMF_EXTERN uint32_t qmf::Agent::getEpoch ( ) const
QMF_EXTERN std::string qmf::Agent::getInstance ( ) const
QMF_EXTERN std::string qmf::Agent::getName ( ) const
QMF_EXTERN const std::string& qmf::Agent::getPackage ( uint32_t  ) const
QMF_EXTERN 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.

QMF_EXTERN std::string qmf::Agent::getProduct ( ) const
QMF_EXTERN Schema qmf::Agent::getSchema ( const SchemaId ,
qpid::messaging::Duration  timeout = qpid::messaging::Duration::MINUTE 
)

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.

QMF_EXTERN SchemaId qmf::Agent::getSchemaId ( const std::string &  ,
uint32_t   
) const
QMF_EXTERN 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.

QMF_EXTERN std::string qmf::Agent::getVendor ( ) const
QMF_EXTERN Agent& qmf::Agent::operator= ( const Agent )
QMF_EXTERN ConsoleEvent qmf::Agent::query ( const Query ,
qpid::messaging::Duration  timeout = qpid::messaging::Duration::MINUTE 
)
QMF_EXTERN ConsoleEvent qmf::Agent::query ( const std::string &  ,
qpid::messaging::Duration  timeout = qpid::messaging::Duration::MINUTE 
)
QMF_EXTERN uint32_t qmf::Agent::queryAsync ( const Query )
QMF_EXTERN uint32_t qmf::Agent::queryAsync ( const std::string &  )
QMF_EXTERN ConsoleEvent qmf::Agent::querySchema ( qpid::messaging::Duration  timeout = qpid::messaging::Duration::MINUTE)

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].

QMF_EXTERN uint32_t qmf::Agent::querySchemaAsync ( )

Friends And Related Function Documentation

friend struct AgentImplAccess
friend
friend class qmf::PrivateImplRef< Agent >
friend

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