Wombat::MamdaBasicSubscription

More…

#include <MamdaBasicSubscription.h>

Public Functions

Detailed Description

class Wombat::MamdaBasicSubscription;

A MamdaBasicSubscription is used to register interest in a particular symbol. A MamaTransport is required to actually activate the subscription.

Multiple listeners can be added to the MamdaBasicSubscription. In this way, an application can make use of more than one of the specialized value added MAMDA listeners, such as MamdaCalcListener

Public Functions Documentation

function MamdaBasicSubscription

MamdaBasicSubscription()

function ~MamdaBasicSubscription

~MamdaBasicSubscription()

function create

void create(
    MamaTransport * transport,
    MamaQueue * queue,
    const char * symbol,
    void * closure =NULL
)

Create and activate the subscription. You can alternatively set all objects and properties and then call activate is you wish.

function setTimeout

void setTimeout(
    double timeout
)

Set the subscription timeout (in seconds). Do this before calling activate().

function addMsgListener

void addMsgListener(
    MamdaBasicMsgListener * listener
)

Add a listener for regular messages.

function addQualityListener

void addQualityListener(
    MamdaBasicQualityListener * listener
)

Add a listener for changes in quality status.

function addErrorListener

void addErrorListener(
    MamdaBasicErrorListener * listener
)

Add a listener for error events.

function activate

void activate()

Activate the subscription. Until this method is invoked, no updates will be received. Is called by create().

function deactivate

void deactivate()

Deactivate the subscription. No more updates will be received for this subscription (unless activate() is invoked again).

function setSymbol

void setSymbol(
    const char * symbol
)

Set the symbol for the subscription. Do this before calling activate().

function getSymbol

const char * getSymbol() const

Get the symbol for the subscription.

function setClosure

void setClosure(
    void * closure
)

Set the closure for the subscription. Do this before calling activate().

function getClosure

void * getClosure() const

Get the additional object passed as the closure to the create() method.

function setTransport

void setTransport(
    MamaTransport * transport
)

Set the MAMA transport. Do this before calling activate().

function getTransport

MamaTransport * getTransport() const

Get the MamaTransport for this subscription

function setQueue

void setQueue(
    MamaQueue * queue
)

Set the MAMA queue. Do this before calling activate().

function getQueue

MamaQueue * getQueue() const

Get the MAMA queue for this subscription.

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