The message callback interface for basic subscriptions.
More...
#include <MamaBasicSubscriptionCallback.h>
Public Member Functions |
virtual | ~MamaBasicSubscriptionCallback () |
virtual void | onCreate (MamaBasicSubscription *subscription)=0 |
| Method invoked when subscription creation is complete, and before any calls to onMsg .
|
virtual void | onError (MamaBasicSubscription *subscription, const MamaStatus &status, const char *topic)=0 |
| Invoked if an error occurs during prior to subscription creation or if the subscription receives a message for an unentitled topic.
|
virtual void | onMsg (MamaBasicSubscription *subscription, MamaMsg &msg)=0 |
| Invoked when a message arrives.
|
virtual void | onDestroy (MamaBasicSubscription *subscription, void *closure) |
| This method is invoked when a subscription has been completely destroyed, the client can have confidence that no further events will be placed on the queue for this subscription.
|
Detailed Description
The message callback interface for basic subscriptions.
Callers provide an object implementing this interface on creating a MamaSubscription
.
Copyright 2003 Wombat Consulting
- See Also
- MamaSubscription
- Author
- mls
Constructor & Destructor Documentation
virtual Wombat::MamaBasicSubscriptionCallback::~MamaBasicSubscriptionCallback |
( |
| ) |
|
|
virtual |
Member Function Documentation
Method invoked when subscription creation is complete, and before any calls to onMsg
.
Since subscriptions are created asynchronous by throttle, this callback provides the subscription instance after the throttle processes the creation request.
- Parameters
-
subscription | The subscription. |
Invoked if an error occurs during prior to subscription creation or if the subscription receives a message for an unentitled topic.
If the status is MamaMsgStatus.NOT_ENTITTLED
the topic parameter is the specific unentitled topic. If the subscription topic contains wildcards, the subscription may still receive messages for other entitled topics.
- Parameters
-
subscription | The subscription. |
status | The wombat error code. |
topic | The topic for NOT_ENTITLED |
Invoked when a message arrives.
- Parameters
-
virtual void Wombat::MamaBasicSubscriptionCallback::onDestroy |
( |
MamaBasicSubscription * |
subscription, |
|
|
void * |
closure |
|
) |
| |
|
virtual |
This method is invoked when a subscription has been completely destroyed, the client can have confidence that no further events will be placed on the queue for this subscription.
@param[in] subscription The The Mama Basic Subscription.
- Parameters
-
[in] | closure | The closure passed to the create function. |
The documentation for this class was generated from the following file: