Classes Files

Wombat::MamaBasicWildCardSubscriptionCallback

More…

#include <MamaBasicWildCardSubscriptionCallback.h>

Public Functions

  Name
virtual ~MamaBasicWildCardSubscriptionCallback()
virtual void onCreate(MamaBasicWildCardSubscription * subscription) =0
virtual void onError(MamaBasicWildCardSubscription * subscription, const MamaStatus & status, const char * topic) =0
virtual void onDestroy(MamaBasicWildCardSubscription * subscription, void * closure)
virtual void onMsg(MamaBasicWildCardSubscription * subscription, MamaMsg & msg, const char * topic) =0

Detailed Description

class Wombat::MamaBasicWildCardSubscriptionCallback;

The message callback interface for basic subscriptions. Callers provide an object implementing this interface on creating a [MamaSubscription](classWombat_1_1MamaSubscription.html).

Public Functions Documentation

function ~MamaBasicWildCardSubscriptionCallback

inline virtual ~MamaBasicWildCardSubscriptionCallback()

function onCreate

virtual void onCreate(
    MamaBasicWildCardSubscription * subscription
) =0

Parameters:

  • subscription The subscription.

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.

function onError

virtual void onError(
    MamaBasicWildCardSubscription * subscription,
    const MamaStatus & status,
    const char * topic
) =0

Parameters:

  • subscription The subscription.
  • status The wombat error code.
  • topic The topic for NOT_ENTITLED

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.

function onDestroy

inline virtual void onDestroy(
    MamaBasicWildCardSubscription * subscription,
    void * closure
)

Parameters:

  • subscription The The Mama Basic Wildcard Subscription.
  • closure The closure passed to the create function.

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.

function onMsg

virtual void onMsg(
    MamaBasicWildCardSubscription * subscription,
    MamaMsg & msg,
    const char * topic
) =0

Parameters:

  • subscription the [MamaSubscription](classWombat_1_1MamaSubscription.html).
  • msg The TibrvMsg.

Invoked when a message arrives.


Updated on 2023-03-31 at 15:29:25 +0100