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

#include <Subscription.h>

Inheritance diagram for qmf::Subscription:
Collaboration diagram for qmf::Subscription:

Public Member Functions

QMF_EXTERN Subscription (SubscriptionImpl *impl=0)
 
QMF_EXTERN Subscription (const Subscription &)
 
QMF_EXTERN Subscriptionoperator= (const Subscription &)
 
QMF_EXTERN ~Subscription ()
 
QMF_EXTERN void cancel ()
 
QMF_EXTERN bool isActive () const
 
QMF_EXTERN void lock ()
 
QMF_EXTERN void unlock ()
 
QMF_EXTERN uint32_t getDataCount () const
 
QMF_EXTERN Data getData (uint32_t) const
 
- Public Member Functions inherited from qmf::Handle< SubscriptionImpl >
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< SubscriptionImpl > &h)
 

Friends

class qmf::PrivateImplRef< Subscription >
 
struct SubscriptionImplAccess
 

Additional Inherited Members

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

Constructor & Destructor Documentation

QMF_EXTERN qmf::Subscription::Subscription ( SubscriptionImpl *  impl = 0)
QMF_EXTERN qmf::Subscription::Subscription ( const Subscription )
QMF_EXTERN qmf::Subscription::~Subscription ( )

Member Function Documentation

QMF_EXTERN void qmf::Subscription::cancel ( )

Construction: A subscription is created by calling ConsoleSession::subscribe. Cancel subscriptions to all subscribed agents. After this is called, the subscription shall be inactive.

QMF_EXTERN Data qmf::Subscription::getData ( uint32_t  ) const
QMF_EXTERN uint32_t qmf::Subscription::getDataCount ( ) const
QMF_EXTERN bool qmf::Subscription::isActive ( ) const

Check to see if this subscription is active. It is active if it has a live subscription on at least one agent. If it is not active, there is nothing that can be done to make it active, it can only be deleted.

QMF_EXTERN void qmf::Subscription::lock ( )

lock and unlock should be used to bracket a traversal of the data set. After lock is called, the subscription will not change its set of available data objects. Between calls to getDataCount and getData, no data objects will be added or removed. After unlock is called, the set of data will catch up to any activity that occurred while the lock was in effect.

QMF_EXTERN Subscription& qmf::Subscription::operator= ( const Subscription )
QMF_EXTERN void qmf::Subscription::unlock ( )

Friends And Related Function Documentation

friend class qmf::PrivateImplRef< Subscription >
friend
friend struct SubscriptionImplAccess
friend

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