#include <qmf/Subscription.h>
List of all members.
Protected Types |
typedef SubscriptionImpl | Impl |
Detailed Description
Definition at line 38 of file Subscription.h.
Member Typedef Documentation
Constructor & Destructor Documentation
qmf::Subscription::Subscription |
( |
SubscriptionImpl * |
impl = 0 | ) |
|
qmf::Subscription::~Subscription |
( |
| ) |
|
Member Function Documentation
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.
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.
- 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.
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.
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.
void qmf::Subscription::unlock |
( |
| ) |
|
Member Data Documentation
The documentation for this class was generated from the following file: