Wombat::MamdaPubStatusListener Class Reference

MamdaPubStatusListener is a class that specializes in handling Publisher (Feed Handler) Status updates. More...

#include <MamdaPubStatusListener.h>

Inheritance diagram for Wombat::MamdaPubStatusListener:

Public Member Functions
	MamdaPubStatusListener ()
virtual	~MamdaPubStatusListener ()
void	addHandler (MamdaPubStatusHandler *handler)
void	updateFieldStates ()
const char *	getSymbol () const
	Accessor function for generic fields applicable to all 5 publisher status message types.
const char *	getActivityTime () const
const char *	getActivityDate () const
const char *	getPubId () const
const char *	getPubClass () const
const char *	getPubHostName () const
MamdaFieldState	getSymbolFieldState () const
MamdaFieldState	getActivityTimeFieldState () const
MamdaFieldState	getActivityDateFieldState () const
MamdaFieldState	getPubIdFieldState () const
MamdaFieldState	getPubClassFieldState () const
MamdaFieldState	getPubHostNameFieldState () const
const char *	getStatusMsgType () const
	Accessor function to the publisher status message type:
MamdaFieldState	getStatusMsgTypeFieldState () const
const char *	getPubFtMode () const
	Accessor functions for fields specific to a particular message type.
const char *	getPubMhMode () const
const char *	getLineStatus () const
long	getStatusSeqNum () const
long	getBeginGapSeqNum () const
long	getEndGapSeqNum () const
long	getPubCacheSize () const
const char *	getFreeText () const
MamdaFieldState	getPubFtModeFieldState () const
MamdaFieldState	getPubMhModeFieldState () const
MamdaFieldState	getLineStatusFieldState () const
MamdaFieldState	getStatusSeqNumFieldState () const
MamdaFieldState	getBeginGapSeqNumFieldState () const
MamdaFieldState	getEndGapSeqNumFieldState () const
MamdaFieldState	getPubCacheSizeFieldState () const
MamdaFieldState	getFreeTextFieldState () const
virtual void	onMsg (MamdaSubscription *subscription, const MamaMsg &msg, short msgType)
	Implementation of MamdaListener interface.
Public Member Functions inherited from Wombat::MamdaMsgListener
virtual	~MamdaMsgListener ()
Public Member Functions inherited from Wombat::MamdaPubStatus
virtual	~MamdaPubStatus ()

Detailed Description

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.

Constructor & Destructor Documentation

Wombat::MamdaPubStatusListener::MamdaPubStatusListener

(

)

virtual Wombat::MamdaPubStatusListener::~MamdaPubStatusListener ( )

virtual

Member Function Documentation

void Wombat::MamdaPubStatusListener::addHandler

(

MamdaPubStatusHandler *

handler

)

void Wombat::MamdaPubStatusListener::updateFieldStates

(

)

const char* Wombat::MamdaPubStatusListener::getSymbol ( ) const

virtual

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

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getActivityTime ( ) const

virtual

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getActivityDate ( ) const

virtual

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getPubId ( ) const

virtual

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getPubClass ( ) const

virtual

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getPubHostName ( ) const

virtual

Implements Wombat::MamdaPubStatus.

MamdaFieldState Wombat::MamdaPubStatusListener::getSymbolFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getActivityTimeFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getActivityDateFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getPubIdFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getPubClassFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getPubHostNameFieldState

(

)

const

const char* Wombat::MamdaPubStatusListener::getStatusMsgType ( ) const

virtual

Accessor function to the publisher status message type:

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

Implements Wombat::MamdaPubStatus.

MamdaFieldState Wombat::MamdaPubStatusListener::getStatusMsgTypeFieldState

(

)

const

const char* Wombat::MamdaPubStatusListener::getPubFtMode ( ) const

virtual

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

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getPubMhMode ( ) const

virtual

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getLineStatus ( ) const

virtual

Implements Wombat::MamdaPubStatus.

long Wombat::MamdaPubStatusListener::getStatusSeqNum ( ) const

virtual

Implements Wombat::MamdaPubStatus.

long Wombat::MamdaPubStatusListener::getBeginGapSeqNum ( ) const

virtual

Implements Wombat::MamdaPubStatus.

long Wombat::MamdaPubStatusListener::getEndGapSeqNum ( ) const

virtual

Implements Wombat::MamdaPubStatus.

long Wombat::MamdaPubStatusListener::getPubCacheSize ( ) const

virtual

Implements Wombat::MamdaPubStatus.

const char* Wombat::MamdaPubStatusListener::getFreeText ( ) const

virtual

Implements Wombat::MamdaPubStatus.

MamdaFieldState Wombat::MamdaPubStatusListener::getPubFtModeFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getPubMhModeFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getLineStatusFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getStatusSeqNumFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getBeginGapSeqNumFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getEndGapSeqNumFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getPubCacheSizeFieldState

(

)

const

MamdaFieldState Wombat::MamdaPubStatusListener::getFreeTextFieldState

(

)

const

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

virtual

Implementation of MamdaListener interface.

Implements Wombat::MamdaMsgListener.

---

The documentation for this class was generated from the following file:

• MamdaPubStatusListener.h