The MamaBasicSubscription
interface represents a subscription to a topic with no market data semantics.
More...
#include <MamaBasicSubscription.h>
The MamaBasicSubscription
interface represents a subscription to a topic with no market data semantics.
- See also
- Mama
- Author
- Michael Schonberg copyright 2003 Wombat Consulting Inc.
virtual Wombat::MamaBasicSubscription::~MamaBasicSubscription |
( |
| ) |
|
|
virtual |
The destructor will call destroy()
if the subscription has not already been destroyed.
Wombat::MamaBasicSubscription::MamaBasicSubscription |
( |
void |
| ) |
|
Create a basic subscription without market data semantics.
- Parameters
-
transport | The transport to use. Must be a basic transport. |
queue | The queue. |
callback | The mamaMsgCallbacks structure containing the three callback methods. |
topic | The topic. |
closure | The caller supplied closure. |
virtual void Wombat::MamaBasicSubscription::destroy |
( |
| ) |
|
|
virtual |
Destroy the subscription.
Destroys the underlying subscription. The subscription can be recreated via a subsequent call to create()
Reimplemented in Wombat::MamaSubscription.
virtual void Wombat::MamaBasicSubscription::destroyEx |
( |
| ) |
|
|
virtual |
This function will destroy the subscription and can be called from any thread.
Note that the subscription will not be fully destroyed until the onDestroy callback is received from the MamaBasicSubscriptionCallback interface. To destroy from the dispatching thread the destroy function should be used in preference.
Reimplemented in Wombat::MamaSubscription.
virtual bool Wombat::MamaBasicSubscription::isActive |
( |
void |
| ) |
const |
|
virtual |
Return whether the subscription is active.
- Returns
- whether the subscription is active.
virtual const char* Wombat::MamaBasicSubscription::getTopic |
( |
void |
| ) |
const |
|
virtual |
Return the symbol for this subscription.
- Returns
- The topic.
virtual MamaTransport* Wombat::MamaBasicSubscription::getTransport |
( |
void |
| ) |
const |
|
virtual |
Return the MamaTransport
for this subscription.
- Returns
- the transport.
virtual MamaQueue* Wombat::MamaBasicSubscription::getQueue |
( |
void |
| ) |
const |
|
virtual |
Return the MamaQueue
for the subscription.
- Returns
- the queue.
virtual void Wombat::MamaBasicSubscription::setClosure |
( |
void * |
closure | ) |
|
|
virtual |
Set the closure for the subscription.
virtual void* Wombat::MamaBasicSubscription::getClosure |
( |
void |
| ) |
const |
|
virtual |
Return the closure for the subscription.
- Returns
- the closure.
virtual void Wombat::MamaBasicSubscription::setDebugLevel |
( |
MamaLogLevel |
level | ) |
|
|
virtual |
Set the debug level for this subscription.
- Parameters
-
level | The new debug level. |
virtual MamaLogLevel Wombat::MamaBasicSubscription::getDebugLevel |
( |
| ) |
const |
|
virtual |
Return the debug level for this subscription.
- Returns
- the debug level for this subscription.
virtual bool Wombat::MamaBasicSubscription::checkDebugLevel |
( |
MamaLogLevel |
level | ) |
const |
|
virtual |
Return whether the debug level for this subscription equals or exceeds some level.
- Parameters
-
level | The debug level to check. |
- Returns
- whether the level equals or exceeds the set level for this subscription.
virtual mamaSubscriptionState Wombat::MamaBasicSubscription::getState |
( |
void |
| ) |
|
|
virtual |
This function will return the current state of the subscription, this function should be used in preference to the mamaSubscription_isActive or mamaSubscription_isValid functions.
This function is thread-safe.
- Returns
- mama_status this can be one of the mamaSubscriptionState enumeration values.
void* Wombat::MamaBasicSubscription::mClosure |
|
protected |
MamaQueue* Wombat::MamaBasicSubscription::mQueue |
|
protected |
mamaSubscription Wombat::MamaBasicSubscription::mSubscription |
|
protected |
The documentation for this class was generated from the following file: