com::wombat::mama::MamaMdMsgType

More…

Public Functions

Public Attributes

Detailed Description

class com::wombat::mama::MamaMdMsgType;

This class provides an enumeration of types and methods for MAMA types related to market data applications.

It is intended that the types in this class will ultimately replace the MamaMsgType as an indicator of the type of market data message received by a subscribing application.

Public Functions Documentation

function toString

inline String toString()

Return: Name for the type.

Returns the stringified name for the enumerated type.

function getValue

inline int getValue()

Return: The integer type.

Returns the integer value for the type. This value can be used in switch statements against the public XXX_VALUE static members of the class.

function equals

inline boolean equals(
    MamaMdMsgType appDataType
)

Parameters:

• appDataType The object to check equality against.

Return: Whether the two objects are equal.

Compare the two types for equality. Returns true if the integer value of both types is equal. Otherwise returns false.

function typeForMsg

static inline MamaMdMsgType typeForMsg(
    final MamaMsg msg
)

Parameters:

• msg The MamaMsg from which the msg type will be extracted.

Return: An instance of a MamaMdMsgType

Get the md msg type from the specified MamaMsg. Returns null if no type was found in the message.

function stringForMsg

static inline String stringForMsg(
    final MamaMsg msg
)

Parameters:

• msg The MamaMsg from which the type is to be extracted.

Return: The string name for the type.

The stringified name of the type based on the int value for the type in the specified message.

function compatMsgType

static inline short compatMsgType(
    MamaMdMsgType mdMsgType
)

Parameters:

• mdMsgType The MamaMdMsgType for which a mapping is required.

Return: The MamaMsgType corresponding to the specified MamaMdMsgType.

Return the corresponding MamaMsgType for the specified MamaMdMsgType. Mainly for backwards compatibility.

function valueToString

static inline String valueToString(
    int value
)

Parameters:

• value The int value for a MamaMdMsgType.

Return: The string name value of the specified MamaMdMsgType integer value.

Utility method for mapping type integer values to corresponding string values.

Returns “UNKNOWN” is the int type value is not recognised.

function enumObjectForValue

static inline MamaMdMsgType enumObjectForValue(
    int value
)

Parameters:

• value Int value for a MamaMdMsgType.

Return: Instance of a MamaMdMsgType if a mapping exists.

Return an instance of a MamaMdMsgType corresponding to the specified integer value. Returns null if the integer value is not recognised.

Public Attributes Documentation

variable CANCEL_VALUE

static final int CANCEL_VALUE = 2;

Trade Cancellation

variable CANCEL

static final MamaMdMsgType CANCEL = new MamaMdMsgType
                         (valueToString (CANCEL_VALUE), 
                          CANCEL_VALUE);

variable ERROR_VALUE

static final int ERROR_VALUE = 3;

Trade Error

variable ERROR

static final MamaMdMsgType ERROR = new MamaMdMsgType
                         (valueToString (ERROR_VALUE), 
                          ERROR_VALUE);

variable CORRECTION_VALUE

static final int CORRECTION_VALUE = 4;

Trade correction

variable CORRECTION

static final MamaMdMsgType CORRECTION = new MamaMdMsgType
                         (valueToString (CORRECTION_VALUE), 
                          CORRECTION_VALUE);

variable CLOSING_VALUE

static final int CLOSING_VALUE = 5;

Closing summary

variable CLOSING

static final MamaMdMsgType CLOSING = new MamaMdMsgType
                         (valueToString (CLOSING_VALUE), 
                          CLOSING_VALUE);

variable SYMBOL_ACTION_VALUE

static final int SYMBOL_ACTION_VALUE = 8;

Action related to this symbol, such as a name change or symbol deletion due to option/future expiration, etc.

variable SYMBOL_ACTION

static final MamaMdMsgType SYMBOL_ACTION = new MamaMdMsgType
                         (valueToString (SYMBOL_ACTION_VALUE), 
                          SYMBOL_ACTION_VALUE);

variable PREOPENING_VALUE

static final int PREOPENING_VALUE = 12;

Pre-opening summary (e.g. morning roll)

variable PREOPENING

static final MamaMdMsgType PREOPENING = new MamaMdMsgType
                         (valueToString (PREOPENING_VALUE), 
                          PREOPENING_VALUE);

variable QUOTE_VALUE

static final int QUOTE_VALUE = 13;

Quote update.

variable QUOTE

static final MamaMdMsgType QUOTE = new MamaMdMsgType
                         (valueToString (QUOTE_VALUE), 
                          QUOTE_VALUE);

variable TRADE_VALUE

static final int TRADE_VALUE = 14;

Trade Update

variable TRADE

static final MamaMdMsgType TRADE = new MamaMdMsgType
                         (valueToString (TRADE_VALUE), 
                          TRADE_VALUE);

variable BOOK_INITIAL_VALUE

static final int BOOK_INITIAL_VALUE = 16;

Order book initial value

variable BOOK_INITIAL

static final MamaMdMsgType BOOK_INITIAL = new MamaMdMsgType
                         (valueToString (BOOK_INITIAL_VALUE),
                          BOOK_INITIAL_VALUE);

variable IMBALANCE_VALUE

static final int IMBALANCE_VALUE = 17;

Order imbalance or noimbalance update

variable IMBALANCE

static final MamaMdMsgType IMBALANCE = new MamaMdMsgType
                         (valueToString (IMBALANCE_VALUE),
                          IMBALANCE_VALUE);

variable SECURITY_STATUS_VALUE

static final int SECURITY_STATUS_VALUE = 18;

Security status update

variable SECURITY_STATUS

static final MamaMdMsgType SECURITY_STATUS = new MamaMdMsgType
                         (valueToString (SECURITY_STATUS_VALUE),
                          SECURITY_STATUS_VALUE);

variable MISC_VALUE

static final int MISC_VALUE = 100;

Miscellaneous.

variable MISC

static final MamaMdMsgType MISC = new MamaMdMsgType
                         (valueToString (MISC_VALUE), 
                          MISC_VALUE);

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