Wombat::MamdaPubStatusListener

More…

#include <MamdaPubStatusListener.h>

Inherits from Wombat::MamdaMsgListener, Wombat::MamdaPubStatus

Public Functions

Additional inherited members

Public Functions inherited from Wombat::MamdaMsgListener

Public Functions inherited from Wombat::MamdaPubStatus

Detailed Description

class Wombat::MamdaPubStatusListener;

MamdaPubStatusListener is a class that specializes in handling Publisher (Feed Handler) Status updates. There are 5 types of publisher status msg:

• Heart Beat (StatusMsgType = “HB”)
• Fault Tolerance (StatusMsgType = “FT”)
• Line Status (StatusMsgType = “LS”)
• Message Handler (StatusMsgType = “MH”)
• Gap (StatusMsgType = “GP”) Note: The MamdaPubStatusListener class cache is cleared when an new update message arrives

MamdaPubStatusListener should initialize the MamdaPubStatusFields class prior to receiving the first message by calling MamdaPubStatusFields::setDictionary() with a valid dictionary object which contains PubStatus related fields.

Public Functions Documentation

function MamdaPubStatusListener

MamdaPubStatusListener()

function ~MamdaPubStatusListener

virtual ~MamdaPubStatusListener()

function addHandler

void addHandler(
    MamdaPubStatusHandler * handler
)

function updateFieldStates

void updateFieldStates()

function getSymbol

virtual const char * getSymbol() const

Reimplements: Wombat::MamdaPubStatus::getSymbol

Accessor function for generic fields applicable to all 5 publisher status message types.

function getActivityTime

virtual const char * getActivityTime() const

Reimplements: Wombat::MamdaPubStatus::getActivityTime

function getActivityDate

virtual const char * getActivityDate() const

Reimplements: Wombat::MamdaPubStatus::getActivityDate

function getPubId

virtual const char * getPubId() const

Reimplements: Wombat::MamdaPubStatus::getPubId

function getPubClass

virtual const char * getPubClass() const

Reimplements: Wombat::MamdaPubStatus::getPubClass

function getPubHostName

virtual const char * getPubHostName() const

Reimplements: Wombat::MamdaPubStatus::getPubHostName

function getSymbolFieldState

MamdaFieldState getSymbolFieldState() const

function getActivityTimeFieldState

MamdaFieldState getActivityTimeFieldState() const

function getActivityDateFieldState

MamdaFieldState getActivityDateFieldState() const

function getPubIdFieldState

MamdaFieldState getPubIdFieldState() const

function getPubClassFieldState

MamdaFieldState getPubClassFieldState() const

function getPubHostNameFieldState

MamdaFieldState getPubHostNameFieldState() const

function getStatusMsgType

virtual const char * getStatusMsgType() const

Reimplements: Wombat::MamdaPubStatus::getStatusMsgType

Accessor function to the publisher status message type:

• HB, FT, LS, MH, or GP.

function getStatusMsgTypeFieldState

MamdaFieldState getStatusMsgTypeFieldState() const

function getPubFtMode

virtual const char * getPubFtMode() const

Reimplements: Wombat::MamdaPubStatus::getPubFtMode

Accessor functions for fields specific to a particular message type. The applicability of each accessor function to a given message type is defined in the comments below; e.g., “getPubFtMode” is only relevant and will only be populated for Heart Beat (HB) and Fault Tolerance (FT) publisher status messages

function getPubMhMode

virtual const char * getPubMhMode() const

Reimplements: Wombat::MamdaPubStatus::getPubMhMode

function getLineStatus

virtual const char * getLineStatus() const

Reimplements: Wombat::MamdaPubStatus::getLineStatus

function getStatusSeqNum

virtual long getStatusSeqNum() const

Reimplements: Wombat::MamdaPubStatus::getStatusSeqNum

function getBeginGapSeqNum

virtual long getBeginGapSeqNum() const

Reimplements: Wombat::MamdaPubStatus::getBeginGapSeqNum

function getEndGapSeqNum

virtual long getEndGapSeqNum() const

Reimplements: Wombat::MamdaPubStatus::getEndGapSeqNum

function getPubCacheSize

virtual long getPubCacheSize() const

Reimplements: Wombat::MamdaPubStatus::getPubCacheSize

function getFreeText

virtual const char * getFreeText() const

Reimplements: Wombat::MamdaPubStatus::getFreeText

function getPubFtModeFieldState

MamdaFieldState getPubFtModeFieldState() const

function getPubMhModeFieldState

MamdaFieldState getPubMhModeFieldState() const

function getLineStatusFieldState

MamdaFieldState getLineStatusFieldState() const

function getStatusSeqNumFieldState

MamdaFieldState getStatusSeqNumFieldState() const

function getBeginGapSeqNumFieldState

MamdaFieldState getBeginGapSeqNumFieldState() const

function getEndGapSeqNumFieldState

MamdaFieldState getEndGapSeqNumFieldState() const

function getPubCacheSizeFieldState

MamdaFieldState getPubCacheSizeFieldState() const

function getFreeTextFieldState

MamdaFieldState getFreeTextFieldState() const

function onMsg

virtual void onMsg(
    MamdaSubscription * subscription,
    const MamaMsg & msg,
    short msgType
)

Reimplements: Wombat::MamdaMsgListener::onMsg

Implementation of MamdaListener interface.

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