Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET | Apache Qpid Documentation |
#include <qmf/Subscription.h>
Inherits qmf::Handle< SubscriptionImpl >.
Public Member Functions | |
Subscription (SubscriptionImpl *impl=0) | |
Subscription (const Subscription &) | |
Subscription & | operator= (const Subscription &) |
~Subscription () | |
void | cancel () |
Cancel subscriptions to all subscribed agents. | |
bool | isActive () const |
Check to see if this subscription is active. | |
void | lock () |
lock and unlock should be used to bracket a traversal of the data set. | |
void | unlock () |
uint32_t | getDataCount () const |
Data | getData (uint32_t) const |
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< SubscriptionImpl > &h) |
Protected Types | |
typedef SubscriptionImpl | Impl |
Protected Attributes | |
Impl * | impl |
Definition at line 38 of file Subscription.h.
typedef SubscriptionImpl qmf::Handle< SubscriptionImpl >::Impl [protected, inherited] |
qmf::Subscription::Subscription | ( | SubscriptionImpl * | impl = 0 |
) |
qmf::Subscription::Subscription | ( | const Subscription & | ) |
qmf::Subscription::~Subscription | ( | ) |
void qmf::Subscription::cancel | ( | ) |
Cancel subscriptions to all subscribed agents.
After this is called, the subscription shall be inactive.
uint32_t qmf::Subscription::getDataCount | ( | ) | const |
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.
bool qmf::Handle< SubscriptionImpl >::isNull | ( | ) | const [inline, inherited] |
bool qmf::Handle< SubscriptionImpl >::isValid | ( | ) | const [inline, inherited] |
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::Handle< SubscriptionImpl >::operator bool | ( | ) | const [inline, inherited] |
bool qmf::Handle< SubscriptionImpl >::operator! | ( | ) | const [inline, inherited] |
Subscription& qmf::Subscription::operator= | ( | const Subscription & | ) |
void qmf::Handle< SubscriptionImpl >::swap | ( | Handle< SubscriptionImpl > & | h | ) | [inline, inherited] |
void qmf::Subscription::unlock | ( | ) |
Impl* qmf::Handle< SubscriptionImpl >::impl [protected, inherited] |