MamdaOptionChainListener is a class that specializes in handling and managing option chain updates. More...
#include <MamdaOptionChainListener.h>
Public Member Functions | |
MamdaOptionChainListener (const char *underlyingSymbol) | |
Create a specialized option chain listener. More... | |
MamdaOptionChainListener (MamdaOptionChain *chain) | |
Create a specialized option chain listener. More... | |
virtual | ~MamdaOptionChainListener () |
Destructor. More... | |
void | setManditoryFields (bool expireDate, bool strikePrice, bool putCall) |
Call this function to control whether or not option contracts, which are missing expireDate, strikePrice, or putCall fields are exposed to the user app by calling the registered onOptionContractCreate(..) callbacks. More... | |
void | addHandler (MamdaOptionChainHandler *handler) |
Add a specialized option chain handler. More... | |
MamdaOptionChain & | getOptionChain () |
Return the option chain associated with this listener. More... | |
const char * | getSymbol () const |
Get the instruments string symbol. More... | |
const char * | getPartId () const |
Get the participant identifier. More... | |
void | onMsg (MamdaSubscription *subscription, const MamaMsg &msg, short msgType) |
Implementation of MamdaListener interface. More... | |
const MamaDateTime & | getSrcTime () const |
Get the source time. More... | |
const MamaDateTime & | getActivityTime () const |
Get the activity time. More... | |
const MamaDateTime & | getLineTime () const |
Get the line time. More... | |
const MamaDateTime & | getSendTime () const |
Get the send time. More... | |
const MamaMsgQual & | getMsgQual () const |
Get the message qualifier. More... | |
const MamaDateTime & | getEventTime () const |
Get the event time. More... | |
mama_seqnum_t | getEventSeqNum () const |
Get the event sequence number. More... | |
MamdaOptionContract * | getOptionContract () const |
char | getOptionAction () const |
MamdaFieldState | getSymbolFieldState () const |
Get the string symbol field state. More... | |
MamdaFieldState | getPartIdFieldState () const |
Get the participant identifier field state. More... | |
MamdaFieldState | getEventSeqNumFieldState () const |
Get the event sequence number field state. More... | |
MamdaFieldState | getEventTimeFieldState () const |
Get the event time field state. More... | |
MamdaFieldState | getSrcTimeFieldState () const |
Get the source time field state. More... | |
MamdaFieldState | getActivityTimeFieldState () const |
Get the activity time field state. More... | |
MamdaFieldState | getLineTimeFieldState () const |
Get the line time of the update. More... | |
MamdaFieldState | getSendTimeFieldState () const |
Get the send time field state. More... | |
MamdaFieldState | getMsgQualFieldState () const |
Get the message qualifier field state. More... | |
![]() | |
virtual | ~MamdaMsgListener () |
![]() | |
const MamdaOptionContract * | getOptionContract () const |
char | getOptionAction () const |
Return the action related to the last series update message. More... | |
![]() | |
virtual | ~MamdaBasicEvent () |
Destructor. More... | |
Additional Inherited Members | |
![]() | |
static const char | ACTION_UNKNOWN = ' ' |
static const char | ACTION_ADD = 'A' |
static const char | ACTION_DELETE = 'D' |
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.
Wombat::MamdaOptionChainListener::MamdaOptionChainListener | ( | const char * | underlyingSymbol) |
Create a specialized option chain listener.
This listener handles option chain updates.
underlyingSymbol | The underlying symbol for the option chain. |
Wombat::MamdaOptionChainListener::MamdaOptionChainListener | ( | MamdaOptionChain * | chain) |
Create a specialized option chain listener.
This listener handles option chain updates.
chain | The option chain object. |
|
virtual |
Destructor.
void Wombat::MamdaOptionChainListener::setManditoryFields | ( | bool | expireDate, |
bool | strikePrice, | ||
bool | putCall | ||
) |
Call this function to control whether or not option contracts, which are missing expireDate, strikePrice, or putCall fields are exposed to the user app by calling the registered onOptionContractCreate(..) callbacks.
Passing a value of false will allow contracts without the particular field to be exposed, passing a value of true will ensure options without this field will not reach the user app. By default all three fields are considered mandatory.
expireDate | Whether the expiration date is mandatory. |
strikePrice | Whether the strikePrice is mandatory. |
putCall | Whether the put/call indicator is mandatory. |
void Wombat::MamdaOptionChainListener::addHandler | ( | MamdaOptionChainHandler * | handler) |
Add a specialized option chain handler.
Currently, only one handler can (and must) be registered.
handler | An instance of the handler which will receive callback updates for activity on the option chain. |
MamdaOptionChain& Wombat::MamdaOptionChainListener::getOptionChain | ( | ) |
Return the option chain associated with this listener.
|
virtual |
Get the instruments string symbol.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the participant identifier.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Implementation of MamdaListener interface.
Implements Wombat::MamdaMsgListener.
|
virtual |
Get the source time.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the activity time.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the line time.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the send time.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the message qualifier.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the event time.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the event sequence number.
Implements Wombat::MamdaBasicEvent.
MamdaOptionContract* Wombat::MamdaOptionChainListener::getOptionContract | ( | ) | const |
char Wombat::MamdaOptionChainListener::getOptionAction | ( | ) | const |
|
virtual |
Get the string symbol field state.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the participant identifier field state.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the event sequence number field state.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the event time field state.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the source time field state.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the activity time field state.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the line time of the update.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the send time field state.
Implements Wombat::MamdaBasicEvent.
|
virtual |
Get the message qualifier field state.
Implements Wombat::MamdaBasicEvent.