﻿

# Namespace List

The namespaces specified in this document are:

Namespace | Assembly | Summary
--- | --- | ---
Wombat | MAMA |

# Namespace : Wombat

﻿

## Wombat Type List

### Interfaces

Type | Summary
--- | ---
MamaDictionaryCallback | Summary description for MamaDictionaryCallback.
MamaMsgFieldIterator | Summary description for MamaMsgFieldIterator.
MamaQueueCallback | Summary description for MamQueueCallback.
MamaSubscriptionCallback | Summary description for MamaSubscriptionCallback.
MamaTimerCallback | Prototype for callback invoked by timer.
MamaTransportCallback | Summary description for MamaTransportCallback.

### Enumerations

Type | Summary
--- | ---
mamaFieldType | mamaFieldType
MamaLogLevel | MamaLogLevel
mamaMsgCreation | What type of message to be constructed
mamaMsgStatus | mamaMsgStatus
mamaMsgType | mamaMsgType
mamaPricePrecision | mamaPricePrecision
mamaQuality | mamaQuality
mamaServiceLevel | mamaServiceLevel
mamaStatus | mamaStatus
mamaSubscriptionType | mamaSubscriptionType

### Classes

Type | Summary
--- | ---
Globals | Mama globals ( aka MAMA_OPEN_MD )
Mama | Summary description for MAMA.
MamaDictionary | Summary description for MamaDictionary.
MamaFieldDescriptor | Summary description for MamaFieldDescriptor.
MamaMsg | Summary description for MamaMsg.
MamaMsgField | Summary description for MamaMsgField.
MamaPrice | Summary description for MamaPrice.
MamaQueue | Summary description for MamaQueue.
MamaQueueGroup | Summary description for MamaQueueGroup.
MamaStatus | Summary description for MamaStatus.
MamaSubscription | Summary description for MamaSubscription.
MamaTimer | Summary description for MamaTimer.
MamaTransport | Summary description for MamaTransport.

﻿

## Wombat Interfaces

### MamaDictionaryCallback Interface

#### Summary

`public interface MamaDictionaryCallback`

Summary description for MamaDictionaryCallback.

#### Method Members

Name | Access | Summary
--- | --- | ---
onComplete(MamaDictionary dictionary) : Void | public | onComplete
onError(MamaDictionary dictionary, String message) : Void | public | onError
onTimeout(MamaDictionary dictionary) : Void | public | onTimeout

### MamaMsgFieldIterator Interface

#### Summary

`public interface MamaMsgFieldIterator`

Summary description for MamaMsgFieldIterator.

#### Method Members

Name | Access | Summary
--- | --- | ---
onField(MamaMsg msg, MamaMsgField field, Object closure) : Void | public | onField

### MamaQueueCallback Interface

#### Summary

`public interface MamaQueueCallback`

Summary description for MamQueueCallback.

#### Method Members

Name | Access | Summary
--- | --- | ---
Enqueue(MamaQueue mamaQueue) : Void | public | Method which is invoked when an event is enqueued on the queue for which this function was registered. LBM Bridge: NB! Users may not dispatch events from this function. The function is invoked from an LBM internal thread. Attempts to dispatch from here will result in a deadlock.

### MamaSubscriptionCallback Interface

#### Summary

`public interface MamaSubscriptionCallback`

Summary description for MamaSubscriptionCallback.

#### Method Members

Name | Access | Summary
--- | --- | ---
onCreate(MamaSubscription subscription) : Void | public | onCreate
onError(MamaSubscription subscription, mamaStatus status, String subject) : Void | public | onErro
onMsg(MamaSubscription subscription, MamaMsg msg) : Void | public | onMsg
onQuality(MamaSubscription subscription, mamaQuality quality, String symbol) : Void | public | onQuality

### MamaTimerCallback Interface

#### Summary

`public interface MamaTimerCallback`

Prototype for callback invoked by timer.

#### Method Members

Name | Access | Summary
--- | --- | ---
onTimer(MamaTimer mamaTimer) : Void | public | Prototype for callback invoked by timer.

### MamaTransportCallback Interface

#### Summary

`public interface MamaTransportCallback`

Summary description for MamaTransportCallback.

#### Method Members

Name | Access | Summary
--- | --- | ---
onDisconnect(MamaTransport transport) : Void | public | onDisconnect
onReconnect(MamaTransport transport) : Void | public | onReconnect

﻿

## Wombat Enumerations

### MamaLogLevel Enumeration

#### Summary

`public enumeration MamaLogLevel`

MamaLogLevel

#### Enumeration Members

Field | Summary
--- | ---
MAMA_LOG_LEVEL_FINE |
MAMA_LOG_LEVEL_FINER |
MAMA_LOG_LEVEL_FINEST |
MAMA_LOG_LEVEL_NORMAL |

### mamaMsgCreation Enumeration

#### Summary

`public enumeration mamaMsgCreation`

What type of message to be constructed

#### Enumeration Members

Field | Summary
--- | ---
NATIVE |
WOMBAT |

### mamaMsgType Enumeration

#### Summary

`public enumeration mamaMsgType`

mamaMsgType

#### Enumeration Members

Field | Summary
--- | ---
MAMA_MSG_TYPE_BOOK_CLEAR |
MAMA_MSG_TYPE_BOOK_INITIAL |
MAMA_MSG_TYPE_BOOK_RECAP |
MAMA_MSG_TYPE_BOOK_SNAPSHOT |
MAMA_MSG_TYPE_BOOK_UPDATE |
MAMA_MSG_TYPE_CANCEL |
MAMA_MSG_TYPE_CLOSING |
MAMA_MSG_TYPE_CORRECTION |
MAMA_MSG_TYPE_DDICT_SNAPSHOT |
MAMA_MSG_TYPE_DELETE |
MAMA_MSG_TYPE_END_OF_INITIALS |
MAMA_MSG_TYPE_ERROR |
MAMA_MSG_TYPE_EXPIRE |
MAMA_MSG_TYPE_FEATURE_SET |
MAMA_MSG_TYPE_INITIAL |
MAMA_MSG_TYPE_MISC |
MAMA_MSG_TYPE_NOT_FOUND |
MAMA_MSG_TYPE_NOT_PERMISSIONED |
MAMA_MSG_TYPE_NULL |
MAMA_MSG_TYPE_ORDER |
MAMA_MSG_TYPE_PREOPENING |
MAMA_MSG_TYPE_QUOTE |
MAMA_MSG_TYPE_RECAP |
MAMA_MSG_TYPE_REFRESH |
MAMA_MSG_TYPE_SNAPSHOT |
MAMA_MSG_TYPE_SYNC_REQUEST |
MAMA_MSG_TYPE_TIBRV |
MAMA_MSG_TYPE_TRADE |
MAMA_MSG_TYPE_UNKNOWN |
MAMA_MSG_TYPE_UPDATE |
MAMA_MSG_TYPE_WOMBAT_CALC |
MAMA_MSG_TYPE_WOMBAT_REQUEST |
MAMA_MSG_TYPE_WORLD_VIEW |

### mamaMsgStatus Enumeration

#### Summary

`public enumeration mamaMsgStatus`

mamaMsgStatus

#### Enumeration Members

Field | Summary
--- | ---
MAMA_MSG_STATUS_BAD_SYMBOL |
MAMA_MSG_STATUS_EXPIRED |
MAMA_MSG_STATUS_LINE_DOWN |
MAMA_MSG_STATUS_MISC |
MAMA_MSG_STATUS_NO_SUBSCRIBERS |
MAMA_MSG_STATUS_NOT_ENTITLED |
MAMA_MSG_STATUS_NOT_FOUND |
MAMA_MSG_STATUS_NOT_PERMISSIONED |
MAMA_MSG_STATUS_OK |
MAMA_MSG_STATUS_PLATFORM_STATUS |
MAMA_MSG_STATUS_POSSIBLY_STALE |
MAMA_MSG_STATUS_STALE |
MAMA_MSG_STATUS_TIBRV_STATUS |
MAMA_MSG_STATUS_TIMEOUT |
MAMA_MSG_STATUS_UNKNOWN |

### mamaFieldType Enumeration

#### Summary

`public enumeration mamaFieldType`

mamaFieldType

#### Enumeration Members

Field | Summary
--- | ---
MAMA_FIELD_TYPE_BOOL |
MAMA_FIELD_TYPE_CHAR |
MAMA_FIELD_TYPE_COLLECTION |
MAMA_FIELD_TYPE_F32 |
MAMA_FIELD_TYPE_F64 |
MAMA_FIELD_TYPE_I16 |
MAMA_FIELD_TYPE_I32 |
MAMA_FIELD_TYPE_I64 |
MAMA_FIELD_TYPE_I8 |
MAMA_FIELD_TYPE_MSG |
MAMA_FIELD_TYPE_OPAQUE |
MAMA_FIELD_TYPE_PRICE |
MAMA_FIELD_TYPE_STRING |
MAMA_FIELD_TYPE_TIME |
MAMA_FIELD_TYPE_U16 |
MAMA_FIELD_TYPE_U32 |
MAMA_FIELD_TYPE_U64 |
MAMA_FIELD_TYPE_U8 |
MAMA_FIELD_TYPE_UNKNOWN |
MAMA_FIELD_TYPE_VECTOR_F32 |
MAMA_FIELD_TYPE_VECTOR_F64 |
MAMA_FIELD_TYPE_VECTOR_I16 |
MAMA_FIELD_TYPE_VECTOR_I32 |
MAMA_FIELD_TYPE_VECTOR_I64 |
MAMA_FIELD_TYPE_VECTOR_I8 |
MAMA_FIELD_TYPE_VECTOR_MSG |
MAMA_FIELD_TYPE_VECTOR_PRICE |
MAMA_FIELD_TYPE_VECTOR_STRING |
MAMA_FIELD_TYPE_VECTOR_TIME |
MAMA_FIELD_TYPE_VECTOR_U16 |
MAMA_FIELD_TYPE_VECTOR_U32 |
MAMA_FIELD_TYPE_VECTOR_U64 |
MAMA_FIELD_TYPE_VECTOR_U8 |

### mamaPricePrecision Enumeration

#### Summary

`public enumeration mamaPricePrecision`

mamaPricePrecision

#### Enumeration Members

Field | Summary
--- | ---
MAMA_PRICE_PREC_10 |
MAMA_PRICE_PREC_100 |
MAMA_PRICE_PREC_1000 |
MAMA_PRICE_PREC_10000 |
MAMA_PRICE_PREC_100000 |
MAMA_PRICE_PREC_1000000 |
MAMA_PRICE_PREC_10000000 |
MAMA_PRICE_PREC_100000000 |
MAMA_PRICE_PREC_1000000000 |
MAMA_PRICE_PREC_10000000000 |
MAMA_PRICE_PREC_CENTS |
MAMA_PRICE_PREC_DIV_128 |
MAMA_PRICE_PREC_DIV_16 |
MAMA_PRICE_PREC_DIV_2 |
MAMA_PRICE_PREC_DIV_256 |
MAMA_PRICE_PREC_DIV_32 |
MAMA_PRICE_PREC_DIV_4 |
MAMA_PRICE_PREC_DIV_512 |
MAMA_PRICE_PREC_DIV_64 |
MAMA_PRICE_PREC_DIV_8 |
MAMA_PRICE_PREC_HALF_32 |
MAMA_PRICE_PREC_HALF_64 |
MAMA_PRICE_PREC_INT |
MAMA_PRICE_PREC_PENNIES |
MAMA_PRICE_PREC_QUARTER_32 |
MAMA_PRICE_PREC_TICK_32 |
MAMA_PRICE_PREC_TICK_64 |
MAMA_PRICE_PREC_UNKNOWN |

### mamaStatus Enumeration

#### Summary

`public enumeration mamaStatus`

mamaStatus

#### Enumeration Members

Field | Summary
--- | ---
MAMA_STATUS_BAD_SYMBOL |
MAMA_STATUS_BAD_TRANSPORT_TYPE |
MAMA_STATUS_ENTITLEMENTS_NOT_ENABLED |
MAMA_STATUS_INVALID_ARG |
MAMA_STATUS_IP_NOT_FOUND |
MAMA_STATUS_MD_NOT_OPENED |
MAMA_STATUS_NOMEM |
MAMA_STATUS_NOT_ENTITLED |
MAMA_STATUS_NOT_FOUND |
MAMA_STATUS_NOT_IMPLEMENTED |
MAMA_STATUS_NULL_ARG |
MAMA_STATUS_OK |
MAMA_STATUS_PLATFORM |
MAMA_STATUS_PROPERTY_TOO_LONG |
MAMA_STATUS_PUB_SUB_NOT_OPENED |
MAMA_STATUS_SYSTEM_ERROR |
MAMA_STATUS_TIMEOUT |
MAMA_STATUS_TIMER_FAILURE |
MAMA_STATUS_TOO_MANY_DISPATCHERS |
MAMA_STATUS_UNSUPPORTED_IO_TYPE |
MAMA_STATUS_WRONG_FIELD_TYPE |

### mamaServiceLevel Enumeration

#### Summary

`public enumeration mamaServiceLevel`

mamaServiceLevel

#### Enumeration Members

Field | Summary
--- | ---
MAMA_SERVICE_LEVEL_CONFLATED |
MAMA_SERVICE_LEVEL_REAL_TIME |
MAMA_SERVICE_LEVEL_REPEATING_SNAPSHOT |
MAMA_SERVICE_LEVEL_SNAPSHOT |
MAMA_SERVICE_LEVEL_UNKNOWN |

### mamaSubscriptionType Enumeration

#### Summary

`public enumeration mamaSubscriptionType`

mamaSubscriptionType

#### Enumeration Members

Field | Summary
--- | ---
MAMA_SUBSC_TYPE_BASIC |
MAMA_SUBSC_TYPE_BOOK |
MAMA_SUBSC_TYPE_DICTIONARY |
MAMA_SUBSC_TYPE_GROUP |
MAMA_SUBSC_TYPE_NORMAL |
MAMA_SUBSC_TYPE_SYMBOL_LIST |

### mamaQuality Enumeration

#### Summary

`public enumeration mamaQuality`

mamaQuality

#### Enumeration Members

Field | Summary
--- | ---
MAMA_QUALITY_MAYBE_STALE |
MAMA_QUALITY_OK |
MAMA_QUALITY_PARTIAL_STALE |
MAMA_QUALITY_STALE |

﻿

## Wombat Classes

### Globals Class

#### Summary

`public class Globals`

Mama globals ( aka MAMA_OPEN_MD )

#### Constructor Members

Name | Access | Summary
--- | --- | ---
Globals() | public | Initializes a new instance of the class.

#### Field Members

Name | Access | Summary
--- | --- | ---
MAMA_DEFAULT_RETRIES : Int32 | public |
MAMA_DEFAULT_THROTTLE_RATE : Int32 | public |
MAMA_DEFAULT_TIMEOUT : Single | public |
MAMA_MAX_SOURCE_LEN : Int32 | public |
MAMA_MAX_SYMBOL_LEN : Int32 | public |
MAMA_MAX_TRANSPORT_LEN : Int32 | public |
MAMA_OPEN_MD : Int32 | public |
MAMA_OPEN_PUB_SUB : Int32 | public |

#### Method Members

Name | Access | Summary
--- | --- | ---

### Mama Class

#### Summary

`public class Mama`

Summary description for MAMA.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
Mama() | public | Initializes a new instance of the class.

#### Method Members

Name | Access | Summary
--- | --- | ---
close() : Void | public | Close MAMA and free all associated resource.
logToFile(String fileName, MamaLogLevel level) : Void | public | Enable logging, accepts a string representing the file location.

open() : Void

public

open() employs a reference count to track multiple calls to open() and close(). The count is incremented every time open() is called and decremeneted when close() is called. The resources are not actually released until the count reaches zero. If entitlements are enabled for the library, the available entitlment server names are read from the entitlement.servers property in the mama.properties file located int the \$WOMBAT_PATH directory.

start() : Void | public | Start processing messages on the internal queue. This starts Mama's internal throttle, refresh logic, and other internal Mama processes as well as dispatching messages from the internal queue. start( ) blocks until an invocation of stop() occurs.
stop() : Void | public | Stop processing messages

### MamaDictionary Class

#### Summary

`public class MamaDictionary`

Summary description for MamaDictionary.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaDictionary() | public | Default constructor

#### Method Members

Name | Access | Summary
--- | --- | ---
create(MamaTransport transport, MamaQueue queue, MamaDictionaryCallback callback, String source) : Void | public | Create a data dictionary from a subscription.
destroy() : Void | public | Destroy this Dictionary object and free all its resources.
Finalize() : Void | protected |

### MamaFieldDescriptor Class

#### Summary

`public class MamaFieldDescriptor`

Summary description for MamaFieldDescriptor.

#### Method Members

Name | Access | Summary
--- | --- | ---
destroy() : Void | public | Destroy a MamaFieldDescriptor
Finalize() : Void | protected |
getFid() : Int32 | public | Return the field identifier.
getName() : String | public | Return the human readable name of the field.
getType() : mamaFieldType | public | Return the data type.
getTypeName() : String | public | Return a human readable string for mamaMsgType.

### MamaMsg Class

#### Summary

`public class MamaMsg`

Summary description for MamaMsg.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaMsg(MamaMsg mamaMsgSrc) | public | Create a deep copy of a message.
MamaMsg(mamaMsgCreation creation) | public | Create a msg. Will create a message format native to the underlying tranport being used. I.e. On Rv the newly created MamaMsg will wrap a tibrvMsg structure.

#### Method Members

Name | Access | Summary
--- | --- | ---
addBool(String name, UInt16 fid, Boolean val) : Void | public | Add a new bool field.
addChar(String name, UInt16 fid, Char val) : Void | public | Add a new char field.
addDateTime(String name, UInt16 fid, DateTime val) : Void | public | Add a MAMA date/time field.
addF32(String name, UInt16 fid, Single val) : Void | public | Add a new float (f32) field.
addF64(String name, UInt16 fid, Double val) : Void | public | Add a new f64 field.
addI16(String name, UInt16 fid, Int16 val) : Void | public | Add a new 16 bit signed int field.
addI32(String name, UInt16 fid, Int32 val) : Void | public | Add a new 32 bit unsigned int field.
addI64(String name, UInt16 fid, Int64 val) : Void | public | Add a new I64 field.
addI8(String name, UInt16 fid, SByte val) : Void | public | Add a new 8 bit signed int field.
addOpaque(String name, UInt16 fid, Byte[] val) : Void | public | Add an opaque field.
addPrice(String name, UInt16 fid, MamaPrice val) : Void | public | Add a MAMA price field.
addString(String name, UInt16 fid, String val) : Void | public | Add a string field.
addU16(String name, UInt16 fid, UInt16 val) : Void | public | Add a new 16 bit unsigned int field.
addU32(String name, UInt16 fid, UInt32 val) : Void | public |
addU64(String name, UInt16 fid, UInt64 val) : Void | public | Add a new U64 field.
addU8(String name, UInt16 fid, Byte val) : Void | public | Add a new 8 bit unsigned int field.
addVectorBool(String name, UInt16 fid, Boolean[] val) : Void | public | Add an array of booleans to the message.
addVectorChar(String name, UInt16 fid, Char[] val) : Void | public | Add an array of characters to the message.
addVectorDateTime(String name, UInt16 fid, DateTime[] val) : Void | public | Add an array of timestamps to the message.
addVectorF32(String name, UInt16 fid, Single[] val) : Void | public | Add an array of 32 bit floating point numbers to the message.
addVectorF64(String name, UInt16 fid, Double[] val) : Void | public | Add an array of 64 bit floating point numbers to the message.
addVectorI16(String name, UInt16 fid, Int16[] val) : Void | public | Add an array of signed 16 bit integers to the message.
addVectorI32(String name, UInt16 fid, Int32[] val) : Void | public | Add an array of signed 32 bit integers to the message.
addVectorI64(String name, UInt16 fid, Int64[] val) : Void | public | Add an array of signed 64 bit integers to the message.
addVectorI8(String name, UInt16 fid, SByte[] val) : Void | public | Add an array of signed 8 bit integers to the message.
addVectorMsg(String name, UInt16 fid, MamaMsg[] val) : Void | public | Add an array of mamaMsg objects to the message.
addVectorPrice(String name, UInt16 fid, MamaPrice[] val) : Void | public | Add an array of prices to the message.
addVectorString(String name, UInt16 fid, String[] val) : Void | public | Add an array of strings (char*) to the message.
addVectorU16(String name, UInt16 fid, UInt16[] val) : Void | public | Add an array of unsigned 16 bit integers to the message.
addVectorU32(String name, UInt16 fid, UInt32[] val) : Void | public | Add an array of unsigned 32 bit integers to the message.
addVectorU64(String name, UInt16 fid, UInt64[] val) : Void | public | Add an array of unsigned 64 bit integers to the message.
addVectorU8(String name, UInt16 fid, Byte[] val) : Void | public | Add an array of unsigned 8 bit integers to the message.
clear() : Void | public | Clear a msg. All fields are removed.
destroy() : Void | public | Destroy a message and free any resources associated with it. @param msg The message.
Finalize() : Void | protected |
getBool(String name, UInt16 fid) : Boolean | public | Get a bool field.
getByteSize() : Int32 | public | Get the size of the underlying message in bytes. Only works for tibrvMsg and wombatmsg types. ELvin does not support this functionality.
getChar(String name, UInt16 fid) : Char | public | Get a char field.
getDateTime(String name, UInt16 fid) : DateTime | public | Get a MAMA date/time field.
getEntitleCode() : Int32 | public | Get the entitle code for this message. The result defaults to 0 (no entitlement) if the field is not present.
getF32(String name, UInt16 fid) : Single | public | Get a float (f32) field.
getF64(String name, UInt16 fid) : Double | public | Get a f64 field.
getField(String name, UInt16 fid) : MamaMsgField | public | Get a MAMA msg field. The result contains the reuseable field object of the mamaMsg object. Applications calling this method will recieve the same reusable object for repeated calls on same mamaMsg object.
getFieldAsString(String name, UInt16 fid) : String | public | Return the field value as string
getI16(String name, UInt16 fid) : Int16 | public | Get a I16, signed 16 bit integer, field.
getI32(String name, UInt16 fid) : Int32 | public | Get a I32, signed 32 bit integer, field.
getI64(String name, UInt16 fid) : Int64 | public | Get a I64, signed 64 bit integer, field.
getI8(String name, UInt16 fid) : SByte | public | Get a I8, signed 8 bit integer, field.
getMsg(String name, UInt16 fid) : MamaMsg | public | Get a submessage.
getNumFields() : Int32 | public | Returns the total number of fields in the message. Sub-messages count as a single field.
getOpaque(String name, UInt16 fid) : Byte[] | public | Get an opaque field.
getPrice(String name, UInt16 fid) : MamaPrice | public | Get a MAMA price field.
getSeqNum() : UInt32 | public | Return the sequence
getStatus() : mamaMsgStatus | public | Return the status
getString(String name, UInt16 fid) : String | public | Get a string field.
getType() : mamaMsgType | public | Extract the type
getU16(String name, UInt16 fid) : UInt16 | public | Get a U16, usigned 16 bit integer, field.
getU32(String name, UInt16 fid) : UInt32 | public | Get a U32, unsigned 32 bit integer, field.
getU64(String name, UInt16 fid) : UInt64 | public | Get a U64, unsigned 64 bit integer, field.
getU8(String name, UInt16 fid) : Byte | public | Get a I8, signed 8 bit integer, field.
getVectorBool(String name, UInt16 fid) : Boolean[] | public | Get a vector of booleans.
getVectorChar(String name, UInt16 fid) : Char[] | public | Get a vector of chars.
getVectorDateTime(String name, UInt16 fid) : DateTime[] | public | Get a vector of timestamps.
getVectorF32(String name, UInt16 fid) : Single[] | public | Get a vector of 32 bit floating point numbers.
getVectorF64(String name, UInt16 fid) : Double[] | public | Get a vector of 64 bit floating point numbers.
getVectorI16(String name, UInt16 fid) : Int16[] | public | Get a vector of signed 16 bit integers.
getVectorI32(String name, UInt16 fid) : Int32[] | public | Get a vector of signed 32 bit integers.
getVectorI64(String name, UInt16 fid) : Int64[] | public | Get a vector of signed 64 bit integers.
getVectorI8(String name, UInt16 fid) : SByte[] | public | Get a vector of signed 8 bit integers.
getVectorMsg(String name, UInt16 fid) : MamaMsg[] | public | Get a vector of submessages.
getVectorPrice(String name, UInt16 fid) : MamaPrice[] | public | Get a vector of prices.
getVectorString(String name, UInt16 fid) : String[] | public | Get a vector of strings (char*).
getVectorU16(String name, UInt16 fid) : UInt16[] | public | Get a vector of unsigned 16 bit integers.
getVectorU32(String name, UInt16 fid) : UInt32[] | public | Get a vector of unsigned 32 bit integers.
getVectorU64(String name, UInt16 fid) : UInt64[] | public | Get a vector of unsigned 64 bit integers.
getVectorU8(String name, UInt16 fid) : Byte[] | public | Get a vector of unsigned 8 bit integers.
iterateFields(MamaMsgFieldIterator iterator, MamaDictionary dictionary, Object closure) : Void | public | Invoke the specified callback for each field in the message.
stringForMsg() : String | public | Return the string for this message
stringForType(mamaMsgType type) : String | public | Return the type name.
ToString() : String | public | Return a string representation the message.
typeForMsg() : mamaMsgType | public | Extract the type from the supplied message.
updateBool(String name, UInt16 fid, Boolean val) : Void | public | Update the val of an existing bool field. If the field does not exist it is added.
updateChar(String name, UInt16 fid, Char val) : Void | public | Update the val of an existing char field. If the field does not exist it is added.
updateDateTime(String name, UInt16 fid, DateTime val) : Void | public | Update a MAMA date/time field.
updateF32(String name, UInt16 fid, Single val) : Void | public | Update the val of an existing float field. If the field does not exist it is added.
updateF64(String name, UInt16 fid, Double val) : Void | public | Update the val of an existing f64 field. If the field does not exist it is added.
updateI16(String name, UInt16 fid, Int16 val) : Void | public | Update the val of an existing I16 field. If the field does not exist it is added.
updateI32(String name, UInt16 fid, Int32 val) : Void | public | Update the val of an existing I32 field. If the field does not exist it is added.
updateI64(String name, UInt16 fid, Int64 val) : Void | public | Update the val of an existing I64 field. If the field does not exist it is added.
updateI8(String name, UInt16 fid, SByte val) : Void | public | Update the val of an existing I8 field. If the field does not exist it is added.
updateOpaque(String name, UInt16 fid, Byte[] val) : Void | public | Update an opaque field.
updatePrice(String name, UInt16 fid, MamaPrice val) : Void | public | Update a MAMA price field.
updateString(String name, UInt16 fid, String val) : Void | public | Update the val of an existing string field. If the field does not exist it is added.
updateU16(String name, UInt16 fid, UInt16 val) : Void | public | Update the val of an existing U16 field. If the field does not exist it is added.
updateU32(String name, UInt16 fid, UInt32 val) : Void | public | Update the val of an existing U32 field. If the field does not exist it is added.
updateU64(String name, UInt16 fid, UInt64 val) : Void | public | Update the val of an existing U64 field. If the field does not exist it is added.
updateU8(String name, UInt16 fid, Byte val) : Void | public | Update the val of an existing U8 field. If the field does not exist it is added.

### MamaMsgField Class

#### Summary

`public class MamaMsgField`

Summary description for MamaMsgField.

#### Method Members

Name | Access | Summary
--- | --- | ---
destroy() : Void | public |
Finalize() : Void | protected |
getAsString() : String | public | Convert the value of the specified field to a string. ( up to 255 characters )
getBool() : Boolean | public | Get a boolean field.
getChar() : Char | public | Get a character field.
getDateTime() : DateTime | public | Get a MAMA date/time field.
getDescriptor() : MamaFieldDescriptor | public | Get the field descriptor for this field.
getF64() : Double | public | Get a F64, floating point 64 bit integer, field.
getFid() : Int32 | public | Get the field ID for this field.
getI16() : Int16 | public | Get a I16, signed 16 bit integer, field.
getI32() : Int32 | public | Get a I32, signed 32 bit integer, field.
getI64() : Int64 | public | Get a I64, signed 64 bit integer, field.
getI8() : SByte | public | Get a I8, signed 8 bit integer, field.
getName() : String | public | Get the field name for this field.
getOpaque() : Byte[] | public | Get an opaque field.
getPrice() : MamaPrice | public | Get a MAMA price field.
getString() : String | public | Get a string field.
getType() : mamaFieldType | public | Get the field type for this field.
getTypeName() : String | public | Get the type name for this field. This is a human readable representation of the type.
getU16() : UInt16 | public | Get a U16, unsigned 16 bit integer, field.
getU32() : UInt32 | public | Get a U32, unsigned 32 bit integer, field.
getU64() : UInt64 | public | Get a U64, unsigned 64 bit integer, field.
getU8() : Byte | public | Get a U8, unsigned 8 bit integer, field.
getVectorBool() : Boolean[] | public | Get a vector of booleans.
getVectorChar() : Char[] | public | Get a vector of characters.
getVectorF32() : Single[] | public | Get a vector of 32 bit floating point numbers.
getVectorF64() : Double[] | public | Get a vector of 64 bit floating point numbers.
getVectorI16() : Int16[] | public | Get a vector of signed 16 bit integers.
getVectorI32() : Int32[] | public | Get a vector of signed 32 bit integers.
getVectorI64() : Int64[] | public | Get a vector of signed 64 bit integers.
getVectorI8() : SByte[] | public | Get a vector of signed 8 bit integers.
getVectorMsg() : MamaMsg[] | public | Get a vector of submessages.
getVectorString() : String[] | public | Get a vector of strings
getVectorU16() : UInt16[] | public | Get a vector of unsigned 16 bit integers.
getVectorU32() : UInt32[] | public | Get a vector of unsigned 32 bit integers.
getVectorU64() : UInt64[] | public | Get a vector of unsigned 64 bit integers.
getVectorU8() : Byte[] | public | Get a vector of unsigned 8 bit integers.
mgetF32() : Single | public | Get a F32, floating point 32 bit integer, field.

### MamaPrice Class

#### Summary

`public class MamaPrice`

Summary description for MamaPrice.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaPrice() | public | Constructor
MamaPrice(MamaPrice price) | public | Copy constructor

#### Method Members

Name | Access | Summary
--- | --- | ---
add(MamaPrice rhs) : Void | public | Add a price object
clear() : Void | public | Clear a MamaPrice object.
compare(MamaPrice rhs) : Double | public | Compare two price objects. The return value is negative if lhs is earlier than rhs, positive if lhs is greater than rhs and zero if the two are equal.
decimals2Precision(Int32 places) : mamaPricePrecision | public | Return the apppropriate precision code for a given number of decimal places.
denom2Precision(Int32 denominator) : mamaPricePrecision | public | Return the apppropriate precision code for a given fractional denominator.
destroy() : Void | public | Destroy a mamaPrice object.
equal(MamaPrice rhs) : Boolean | public | Check for equality between two price objects.
Finalize() : Void | protected |
getAsString() : String | public | Get the price as a string, formatted according to the hints provided.
getHints() : Byte | public | Get the price hints.
getPrecision() : mamaPricePrecision | public | Get the price precision.
getValue() : Double | public | Get the price value only.
getWithHints(Int32 precision) : Double | public | Get the price with special, optional hints.
isZero() : Boolean | public | Return whether the price has a value equivalent to zero. It may not be exactly 0.0, but we check against +/- epsilon.
negate() : Void | public | egate the price value. Hints and precisions are not affected.
precision2Decimals(Int32 precision) : Int32 | public | Return the number of decimal places for a given precision code.
precision2Denom(Int32 precision) : Int32 | public | Return the fractional denominator for a given precision code.
setFromString(String str) : Void | public | Set the price from a string representation, preserving any detectable hints.
setHints(Byte hints) : Void | public | Set all of the price hints.
setPrecision(mamaPricePrecision precision) : Void | public | Set the price precision.
setValue(Double val) : Void | public | Set the price value only (no hint information).
setWithHints(Double val, Byte hints) : Void | public | Set the price with hint information.
subtract(MamaPrice rhs) : Void | public | Subtract a price object.

### MamaQueue Class

#### Summary

`public class MamaQueue`

Summary description for MamaQueue.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaQueue() | public | reate a queue. Queues allow applications to dispatch events in order with multiple threads using a single MamaDispatcher for each queue.

#### Method Members

Name | Access | Summary
--- | --- | ---
destroy() : Void | public | Destroy the queue.
dispatch() : Void | public | Dispatch messages from the queue. This call blocks and dispatches ntil stopDispatch() is called.
dispatchEvent() : Void | public | Dispatch a single event from the specified queue. If there is no event on the queue simply return and do nothing.
Finalize() : Void | protected |
setEnqueueCallback(MamaQueueCallback callback) : Void | public | Register the specified callback function to receive a callback each time an event is enqueued on the specified MamaQueue
stopDispatch() : Void | public | Unblock the queue as soon as possible. This will cause mamaDispatchers to exit. Creating a new dispatcher will resume dispatching events.
timedDispatch(Int64 timeout) : Void | public | Dispatch messages from the queue. This call blocks and dispatches until timeout has elapsed.

### MamaQueueGroup Class

#### Summary

`public class MamaQueueGroup`

Summary description for MamaQueueGroup.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaQueueGroup(Int32 queueCount) | public | Construct a queue manager with given number of queues/threads

#### Method Members

Name | Access | Summary
--- | --- | ---
destroy() : Void | public | Destroy this object
Finalize() : Void | protected |
getNextQueue() : MamaQueue | public | Iterate over the available queues

### MamaStatus Class

#### Summary

`public class MamaStatus`

Summary description for MamaStatus.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaStatus() | public | Initializes a new instance of the class.

#### Method Members

Name | Access | Summary
--- | --- | ---
stringForStatus(mamaStatus status) : String | public | stringForStatus

### MamaSubscription Class

#### Summary

`public class MamaSubscription`

Summary description for MamaSubscription.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaSubscription() | public | Allocate memory for a new subscription. The subscription is not actually created until a call to one of the create() functions is made. Memory must be freed using the deallocate()

#### Method Members

Name | Access | Summary
--- | --- | ---

create(MamaTransport transport, MamaQueue queue, MamaSubscriptionCallback callback, String source, String symbol) : Void

public

Create a subscription. Subscription creation actually occurs on the throttle queue. An individual subscription cannot be assumed to be fully created until its onCreate() callback has been successfully invoked. The subscription rate can be governed via the setOutboundThrottle. Any subscription properties should be set prior to calling this function.

deallocate() : Void | public | Free the memory for a mamaSubscription which was allocated via a call to constructor This function will call destroy() if the subscription has not already been destroyed.
destroy() : Void | public | Destroy the subscription. This function must be called to destroy resources associated with the subscription. It sends an unsubscribe to the feed handler for subscription management. This function does not free the memory associated with the subscription. create() can be called again after this function has been called.
Finalize() : Void | protected |
setRequiresInitial(Boolean requiresInitial) : Void | public | Whether an initial value is required for the specified subscription. This only applies to market data subscriptions and not to basicsubscriptions. Default value of true indicating that initial values are required.
setRetries(Int32 retries) : Void | public | Set the number of retries when requesting recaps.
setServiceLevel(mamaServiceLevel svcLevel) : Void | public | Set the service level. This method must be invoked before create().
setSubscriptionType(mamaSubscriptionType type) : Void | public | Set the subscription type for the subscription being created. If not called the subscription type defaults to MAMA_SUBSC_TYPE_NORMAL. See mamaSubscriptionType enum for valid values.
setTimeout(Double timeout) : Void | public | Set the timeout for this subscription. The timeout is used for requesting recaps.

### MamaTimer Class

#### Summary

`public class MamaTimer`

Summary description for MamaTimer.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaTimer() | public | Construct a timer object

#### Method Members

Name | Access | Summary
--- | --- | ---

create(MamaQueue queue, MamaTimerCallback action, Double interval) : Void

public

Create a repeating timer. Since the MamaTimer relies on the timer mechanism of the underlying middleware, the resolution of the timer is also dependent on the middleware. Consult your middleware documentation for details. The callback is invoked repetedly at the specified interval until the timer is destroyed. A null value for the queue uses the default mama queue.

destroy() : Void | public | Destroy the timer.
Finalize() : Void | protected |
getInterval() : Double | public | Get the current timer interval.
reset() : Void | public | Reset the timer to the beginning of the interval.
setInterval(Double interval) : Void | public | Set the timer to use a different interval (and reset to the beginning of that interval).

### MamaTransport Class

#### Summary

`public class MamaTransport`

Summary description for MamaTransport.

#### Constructor Members

Name | Access | Summary
--- | --- | ---
MamaTransport() | public | Allocate a transport structure. You need to call destroy() then teh class is no more needed The transport is not created until create() is called. Any transport properties should be set prior to calling create()

#### Method Members

Name | Access | Summary
--- | --- | ---

create(String name) : Void

public

Create a previously allocated transport. Platform specific parameters are read from the properties file mama.properties. The properties file is located in the WOMBAT_PATH directory. The parameters are dependent on the underlying messaging transport. Elvin: supports: mama.elvin.transport.name and mama.elvin.transport.dm.name for the directed messaging connection. The format of these properties is either "URLS:url1,url2,..." or "SCOPE:scope_string". TIBRV: tranports support the follwoing: mama.tibrv.transport.name.service, mama.tibrv.transport.name.network, and mama.tibrv.transport.name.daemon. These correspond to the parameters for tibrvTransport_Create(). LBM: See the example mama.properties supplied with the release.

destroy() : Void | public | Destroy the transport.
Finalize() : Void | protected |
setTransportCallback(MamaTransportCallback callback) : Void | public | Set the transport callback. It receives advisories when a transport disconnects or reconnects. Passing NULL removes the callback.