Wombat::MamdaOptionChainListener

MamdaOptionChainListener is a class that specializes in handling and managing option chain updates. Developers provide their own implementation of the MamdaOptionChainHandler interface and will be delivered notifications for various types of options-related events.

Inherits from Wombat.MamdaMsgListener, Wombat.MamdaOptionSeriesUpdate, Wombat.MamdaBasicEvent

Public Functions

	Name
	MamdaOptionChainListener(string underlyingSymbol) Create a specialized option chain listener. This listener handles option chain updates.
	MamdaOptionChainListener(MamdaOptionChain chain) Create a specialized option chain listener. This listener handles option chain updates.
void	addHandler(MamdaOptionChainHandler handler) Add a specialized option chain handler.
MamdaOptionChain	getOptionChain() Return the option chain associated with this listener.
void	onMsg(MamdaSubscription subscription, MamaMsg msg, mamaMsgType msgType) Implementation of MamdaListener interface.
DateTime	getSrcTime() Returns the source time.
DateTime	getActivityTime()
long	getEventSeqNum()
DateTime	getEventTime()
MamdaOptionContract	getOptionContract() Get the option contract to which the most recent event applies.
MamdaOptionAction	getOptionAction() Get the most recent action.
MamdaFieldState	getSrcTimeFieldState() Returns the field state.
MamdaFieldState	getActivityTimeFieldState() Returns the field state.
MamdaFieldState	getEventSeqNumFieldState() Returns the field state.
MamdaFieldState	getEventTimeFieldState() Returns the field state.
MamdaFieldState	getOptionContractFieldState()
MamdaFieldState	getOptionActionFieldState()
string	getFieldAsString(MamaMsgField field)

Public Functions Documentation

function MamdaOptionChainListener

MamdaOptionChainListener(
    string underlyingSymbol
)

Create a specialized option chain listener. This listener handles option chain updates.

Parameters:

underlyingSymbol

function MamdaOptionChainListener

MamdaOptionChainListener(
    MamdaOptionChain chain
)

Create a specialized option chain listener. This listener handles option chain updates.

Parameters:

chain

function addHandler

void addHandler(
    MamdaOptionChainHandler handler
)

Add a specialized option chain handler.

Parameters:

handler

function getOptionChain

MamdaOptionChain getOptionChain()

Return the option chain associated with this listener.

Return:

function onMsg

void onMsg(
    MamdaSubscription subscription,
    MamaMsg msg,
    mamaMsgType msgType
)

Implementation of MamdaListener interface.

Parameters:

subscription
msg
msgType

Reimplements: Wombat::MamdaMsgListener::onMsg

function getSrcTime

DateTime getSrcTime()

Returns the source time.

Return: Source time. Typically, the exchange generated feed

time stamp. This is often the same as the “event time”,
because many feeds do not distinguish between the actual event
time and when the exchange sent the message.

Reimplements: Wombat::MamdaBasicEvent::getSrcTime

function getActivityTime

DateTime getActivityTime()

Return: Activity time. A feed handler generated time stamp representing when the data item was last updated.

Reimplements: Wombat::MamdaBasicEvent::getActivityTime

function getEventSeqNum

long getEventSeqNum()

Return: Source sequence number. The exchange generated sequence number.

Reimplements: Wombat::MamdaBasicEvent::getEventSeqNum

function getEventTime

DateTime getEventTime()

Return: Event time. Typically, when the event actually occurred. This is often the same as the “source time”, because many feeds do not distinguish between the actual event time and when the exchange sent the message.

Reimplements: Wombat::MamdaBasicEvent::getEventTime

function getOptionContract

MamdaOptionContract getOptionContract()

Get the option contract to which the most recent event applies.

Return: The option contract to which the most recent event applies. If the contract is new, it will have already been added to the chain. If it is being removed, it will have already been removed from the chain.

Reimplements: Wombat::MamdaOptionSeriesUpdate::getOptionContract

function getOptionAction

MamdaOptionAction getOptionAction()

Get the most recent action.

Return: The action related to the last series update message.

Reimplements: Wombat::MamdaOptionSeriesUpdate::getOptionAction

function getSrcTimeFieldState

MamdaFieldState getSrcTimeFieldState()

Returns the field state.

Return: Source time Field State

Reimplements: Wombat::MamdaBasicEvent::getSrcTimeFieldState

function getActivityTimeFieldState

MamdaFieldState getActivityTimeFieldState()

Returns the field state.

Return: Activity time Field State

Reimplements: Wombat::MamdaBasicEvent::getActivityTimeFieldState

function getEventSeqNumFieldState

MamdaFieldState getEventSeqNumFieldState()

Returns the field state.

Return: Source sequence number Field State

Reimplements: Wombat::MamdaBasicEvent::getEventSeqNumFieldState

function getEventTimeFieldState

MamdaFieldState getEventTimeFieldState()

Returns the field state.

Return: Event Time Field State

Reimplements: Wombat::MamdaBasicEvent::getEventTimeFieldState

function getOptionContractFieldState

MamdaFieldState getOptionContractFieldState()

function getOptionActionFieldState

MamdaFieldState getOptionActionFieldState()

function getFieldAsString

string getFieldAsString(
    MamaMsgField field
)

Updated on 2023-03-31 at 15:30:16 +0100