com::wombat::mama::MamaMsg

More…

Public Functions

Protected Functions

Detailed Description

class com::wombat::mama::MamaMsg;

Wrapper class for the native C mama msg structure.

Field identifiers must be greater than or equal to 0. A field identifier of 0 indicates that there is no unique FID and multiple fields with the same name may have FID == 0.

Field lookup proceeds in the following manner.

1. If the fid supplied is non-zero, search for a field with the specified fid and return the field if it exists (the name is not validated). Otherwise return null.
2. If the fid supplied is 0, return the first field encountered with the supplied name or null if no such field exists.
   Get methods for numeric values may result in loss of information through either rounding or truncation when a larger data type is accessed as a smaller one. The result may be the same as the result of casting the larger value to the smaller. For example calling getShort for an integer field with a value greater than Short.MAX_VALUE might return Short.MIN_VALUE. It is also valid to throw a ClassCastException or other appropriate RuntimeException.

Since some message implementations may not natively support all data types, the behaviour may vary substantially. In creating and accessing messages the Wombat APIs assume that the underlying values are stored in the smallest possible fields, and accesses them accordingly. For this reason the minimal requirement is that the methods for accessing and creating fields support the full range of values appropriate for their type. How they deal with larger values should be irrelevant.

Public Functions Documentation

function MamaMsg

inline MamaMsg()

The default construction behaviour is to create the underlying C message structure. We need this when users are creating their own messages when using the publishing API.

function MamaMsg

inline MamaMsg(
    char payloadId
)

Parameters:

• payloadId The identifier of the payload to be used.

Create a MamaMsg.

function MamaMsg

inline MamaMsg(
    MamaPayloadBridge payloadBridge
)

Parameters:

• payloadBridge The MamaPayloadBridge to be used

Create a MamaMsg.

function getStringAsBuffer

inline MamaBuffer getStringAsBuffer(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The field descriptor.

Exceptions:

• WombatException Thrown if the field descriptor is null.

Return: A MamaBuffer containing single byte ASCII characters, to obtain a unicode string call MamaBuffer.asCharBuffer.

This function will obtain a string from the mama message and return it inside a MamaBuffer object without performing any memory allocation that would cause future garbage collection.

function getStringAsBuffer

inline MamaBuffer getStringAsBuffer(
    String name,
    int fid
)

Parameters:

• name The field name.
• fid The field Id.

Return: A MamaBuffer containing single byte ASCII characters, to obtain a unicode string call MamaBuffer.asCharBuffer.

This function will obtain a string from the mama message and return it inside a MamaBuffer object without performing any memory allocation that would cause future garbage collection.

function tryStringAsBuffer

inline boolean tryStringAsBuffer(
    String name,
    int fid,
    MamaBuffer mamaBuffer
)

Parameters:

• name The field name.
• fid The field Id.
• mamaBuffer A MamaBuffer that will contain the string if it is present in the message.

Return: Boolean indicating of the field was present in the message or not.

This function will obtain a string from the mama message and return it inside a MamaBuffer object without performing any memory allocation that would cause future garbage collection. If the field is not in the message the function will return FALSE.

function getPointerVal

inline long getPointerVal()

Return: The message pointer (Long)

Return the native message pointer.

function iterator

inline Iterator iterator(
    MamaDictionary dictionary
)

Parameters:

• dictionary The dictionary to use for iterating over the message

Return: The message iterator (Iterator)

Return a iterator for use with this MamaMsg

function iterator

inline Iterator iterator()

Return: A message iterator (Iterator)

Return an iterator for use with this MamaMsg

function getNumFields

native int getNumFields()

Return: Number of fields in the message as in int

Returns the total number of fields in the message.

function getBoolean

native boolean getBoolean(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a boolean

Returns a Boolean value from the underlying message.

function getBoolean

inline boolean getBoolean(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a boolean

Returns a Boolean value from the underlying message.

function getChar

native char getChar(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a char

Returns a Char value from the underlying message.

function getChar

inline char getChar(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a boolean

Returns a Char value from the underlying message.

function getI8

native byte getI8(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a byte

Returns an I8 value from the underlying message.

function getI8

inline byte getI8(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a byte

Returns a Integer (I8) value from the underlying message.

function getU8

native short getU8(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a short

Returns a U8 value from the underlying message.

function getU8

inline short getU8(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a short

Returns a Unsigned Integer (U8) value from the underlying message.

function getI16

native short getI16(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a short

Returns an I16 value from the underlying message.

function getI16

inline short getI16(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a short

Returns a Integer (U16) value from the underlying message.

function getU16

native int getU16(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a int

Returns a U16 value from the underlying message.

function getU16

inline int getU16(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a int

Returns a Unsigned Integer (U16) value from the underlying message.

function getI32

native int getI32(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a int

Returns an I32 value from the underlying message.

function getI32

inline int getI32(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a int

Returns a Integer (I32) value from the underlying message.

function getU32

native long getU32(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a long

Returns a U32 value from the underlying message.

function getU32

inline long getU32(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a long

Returns a Unsigned Integer (U32) value from the underlying message.

function getI64

native long getI64(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a long

Returns an I64 value from the underlying message.

function getI64

inline long getI64(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a long

Returns a Integer (I64) value from the underlying message.

function getU64

native long getU64(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a long

Returns a U64 value from the underlying message.

function getU64

inline long getU64(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a long

Returns a Unsigned Integer (U64) value from the underlying message.

function getF32

native float getF32(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a float

Returns an F32 value from the underlying message.

function getF32

inline float getF32(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a float

Returns a Float (F32) value from the underlying message.

function getF64

native double getF64(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a double

Returns an F64 value from the underlying message.

function getF64

inline double getF64(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a double

Returns a Double (F64) value from the underlying message.

function getString

native String getString(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a String

Returns a String value from the underlying message.

function getString

inline String getString(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a string

Returns a String value from the underlying message.

function getMsg

native MamaMsg getMsg(
    String name,
    int fid
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: The field value as a MamaMsg

Returns a MamaMsg value from the underlying message.

function getMsg

inline MamaMsg getMsg(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a MamaMsg

Returns a MamaMsg value from the underlying message.

function getByteBuffer

native byte[] getByteBuffer()

Return: The byte array containing the message wire format

Return the internal message buffer as an array of bytes which is suitable for writing to a file. Note that this is a copy of the bytes in the current buffer.

function createFromByteBuffer

inline void createFromByteBuffer(
    byte[] byteArray
)

Parameters:

• byteArray The byte array containing the wire format of the message

Create a mamaMsg from the provided byte buffer. This function causes a memory buffer to be allocated that is persisted for the lifetime of the message. Therefore calling this function a second time will cause an error. Instead destroy the message and then re-created it using this function.

function setNewBuffer

inline void setNewBuffer(
    byte[] byteArray
)

Parameters:

• byteArray The byte array containing the wire format of the message

Exceptions:

• WombatException will be thrown if the byteArray is null

Set a new buffer for an existing mamaMsg. This approach is faster than creating a new message for buffers as the message can reuse memory allocated during previous use.

function getOpaque

native byte[] getOpaque(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a byte[]

Returns a Opaque value from the underlying message.

function getOpaque

inline byte[] getOpaque(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a byte[]

Returns a Opaque (byte[]) value from the underlying message.

function getDateTime

inline MamaDateTime getDateTime(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a MamaDateTime

Returns a MamaDateTime value from the underlying message.

function getDateTime

inline MamaDateTime getDateTime(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a MamaDateTime

Returns a MamaDateTime value from the underlying message.

function getPrice

inline MamaPrice getPrice(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a MamaPrice

Returns a MamaPrice value from the underlying message.

function getPrice

inline MamaPrice getPrice(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a MamaPrice

Returns a MamaPrice value from the underlying message.

function getArrayMsg

native MamaMsg[] getArrayMsg(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a MamaMsg[]

Returns a Message Array value from the underlying message.

function getArrayMsg

inline MamaMsg[] getArrayMsg(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a MamaMsg[]

Returns a MamaMsg Array (MamaMsg[]) value from the underlying message.

function getArrayI8

native byte[] getArrayI8(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a byte[]

Returns an I8 Array value from the underlying message.

function getArrayI8

inline byte[] getArrayI8(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a byte[]

Returns an I8 Array (byte[]) value from the underlying message.

function getArrayU8

native short[] getArrayU8(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a short[]

Returns a U8 Array value from the underlying message.

function getArrayU8

inline short[] getArrayU8(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a short[]

Returns a U8 Array (short[]) value from the underlying message.

function getArrayI16

native short[] getArrayI16(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a short[]

Returns an I16 Array value from the underlying message.

function getArrayI16

inline short[] getArrayI16(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a short[]

Returns a I16 Array (short[]) value from the underlying message.

function getArrayU16

native int[] getArrayU16(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a int[]

Returns a U16 Array value from the underlying message.

function getArrayU16

inline int[] getArrayU16(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a int[]

Returns a U16 Array (int[]) value from the underlying message.

function getArrayI32

native int[] getArrayI32(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a int[]

Returns an I32 Array value from the underlying message.

function getArrayI32

inline int[] getArrayI32(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a int[]

Returns a I32 Array (int[]) value from the underlying message.

function getArrayU32

native long[] getArrayU32(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a long[]

Returns a U32 Array value from the underlying message.

function getArrayU32

inline long[] getArrayU32(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a long[]

Returns a U32 Array (long[]) value from the underlying message.

function getArrayI64

native long[] getArrayI64(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a long[]

Returns an I64 Array value from the underlying message.

function getArrayI64

inline long[] getArrayI64(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a long[]

Returns a I64 Array (long[]) value from the underlying message.

function getArrayU64

native long[] getArrayU64(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a long[]

Returns an U64 Array value from the underlying message.

function getArrayU64

inline long[] getArrayU64(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a long[]

Returns a U64 Array (long[]) value from the underlying message.

function getArrayF32

native float[] getArrayF32(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a float[]

Returns an F32 Array value from the underlying message.

function getArrayF32

inline float[] getArrayF32(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a float[]

Returns a F32 Array (float[]) value from the underlying message.

function getArrayF64

native double[] getArrayF64(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a double[]

Returns an F64 Array value from the underlying message.

function getArrayF64

inline double[] getArrayF64(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Return: The field value as a double[]

Returns a F32 Array (double[]) value from the underlying message.

function getArrayString

native String[] getArrayString(
    String name,
    int fid
)

Parameters:

• name The name of the field
• fid The FID of the field

Return: The field value as a string[]

Returns an String Array value from the underlying message.

function getArrayString

inline String[] getArrayString(
    MamaFieldDescriptor fieldDesc
)

Parameters:

• fieldDesc The MamaFieldDescriptor of the message field that you wich to retrieve

Exceptions:

• WombatException will be thrown if the fieldDesc is null

Return: The field value as a string[]

Returns a String Array (string[]) value from the underlying message.

function getIsDefinitelyDuplicate

native boolean getIsDefinitelyDuplicate()

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: Boolean indiciating whether the message is a duplicate

Returns Boolean indiciating whether the underlying message is definitely duplicate.

function getIsPossiblyDuplicate

native boolean getIsPossiblyDuplicate()

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: Boolean indiciating whether the message is a possibly a duplicate

Returns Boolean indiciating whether the underlying message is possibly duplicate.

function getIsPossiblyDelayed

native boolean getIsPossiblyDelayed()

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: Boolean indiciating whether the message is a possibly delayed

Returns Boolean indiciating whether the underlying message is possibly delayed.

function getIsDefinitelyDelayed

native boolean getIsDefinitelyDelayed()

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: Boolean indiciating whether the message is a definitely delayed

Returns Boolean indiciating whether the underlying message is definitely delayed.

function getIsOutOfSequence

native boolean getIsOutOfSequence()

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Return: Boolean indiciating whether the message is out of sequence

Returns Boolean indiciating whether the underlying message is out of sequence.

function getSeqNum

native long getSeqNum()

Return: The field value as a long

Returns the Sequence Number from the underlying message.

function addBool

inline void addBool(
    String name,
    int fid,
    boolean value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a Boolean value to the underlying message.

function addBoolean

native void addBoolean(
    String name,
    int fid,
    boolean value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a Boolean value to the underlying message.

function addChar

native void addChar(
    String name,
    int fid,
    char value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a Char value to the underlying message.

function addI8

native void addI8(
    String name,
    int fid,
    byte value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I8 (byte) value to the underlying message.

function addU8

native void addU8(
    String name,
    int fid,
    short value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an U8 (byte) value to the underlying message.

function addI16

native void addI16(
    String name,
    int fid,
    short value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I16 (short) value to the underlying message.

function addU16

native void addU16(
    String name,
    int fid,
    int value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an U16 (short) value to the underlying message.

function addI32

native void addI32(
    String name,
    int fid,
    int value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I32 (int) value to the underlying message.

function addU32

native void addU32(
    String name,
    int fid,
    long value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an U32 (int) value to the underlying message.

function addI64

native void addI64(
    String name,
    int fid,
    long value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I64 (long) value to the underlying message.

function addU64

native void addU64(
    String name,
    int fid,
    long value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an U64 (long) value to the underlying message.

function addF32

native void addF32(
    String name,
    int fid,
    float value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an F32 (float) value to the underlying message.

function addF64

native void addF64(
    String name,
    int fid,
    double value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an F64 (double) value to the underlying message.

function addString

native void addString(
    String name,
    int fid,
    String value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an String (Java String) value to the underlying message.

function addDateTime

native void addDateTime(
    String name,
    int fid,
    MamaDateTime value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an MamaDateTime value to the underlying message.

function addPrice

native void addPrice(
    String name,
    int fid,
    MamaPrice value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an MamaPrice value to the underlying message.

function addMsg

native void addMsg(
    String name,
    int fid,
    MamaMsg value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an MamaMsg value to the underlying message.

function addOpaque

native void addOpaque(
    String name,
    int fid,
    byte[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an Opaque (byte[]) value to the underlying message.

function addArrayI8

native void addArrayI8(
    String name,
    int fid,
    byte[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I8 Array (byte[]) value to the underlying message.

function addArrayU8

native void addArrayU8(
    String name,
    int fid,
    short[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a U8 Array (short[]) value to the underlying message.

function addArrayI16

native void addArrayI16(
    String name,
    int fid,
    short[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I16 Array (short[]) value to the underlying message.

function addArrayU16

native void addArrayU16(
    String name,
    int fid,
    int[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a U16 Array (int[]) value to the underlying message.

function addArrayI32

native void addArrayI32(
    String name,
    int fid,
    int[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I32 Array (int[]) value to the underlying message.

function addArrayU32

native void addArrayU32(
    String name,
    int fid,
    long[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a U32 Array (long[]) value to the underlying message.

function addArrayI64

native void addArrayI64(
    String name,
    int fid,
    long[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add an I64 Array (long[]) value to the underlying message.

function addArrayU64

native void addArrayU64(
    String name,
    int fid,
    long[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a U64 Array (long[]) value to the underlying message.

function addArrayF32

native void addArrayF32(
    String name,
    int fid,
    float[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a F32 Array (float[]) value to the underlying message.

function addArrayF64

native void addArrayF64(
    String name,
    int fid,
    double[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a F64 Array (double[]) value to the underlying message.

function addArrayMsg

native void addArrayMsg(
    String name,
    int fid,
    MamaMsg[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The value to be added to the message

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a MamaMsg Array (MamaMsg[]) value to the underlying message.

function addArrayMsgWithLength

native void addArrayMsgWithLength(
    String name,
    int fid,
    MamaMsg[] value,
    int length
)

Parameters:

• name The field name.
• fid The field id.
• value The array of messages.
• length The number of messages to add from the array, if this parameter is outside the array bounds then an exception will be thrown.

Exceptions:

• com.wombat.mama.MamaException

This function will add a new field containing an array of messages. Unlinke addArrayMsg it will not add the entire array but only the number of messages supplied in the length parameter.

function addArrayString

native void addArrayString(
    String name,
    int fid,
    String[] value,
    int length
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The array of strings
• length The number of strings to add from the string array, if this parameter is outside the array bounds then an exception will be thrown.

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a String Array (String[]) value to the underlying message.

function addArrayString

inline void addArrayString(
    String name,
    int fid,
    String[] value
)

Parameters:

• name The name of the field to be added to the message
• fid The FID of the field to be added to the message
• value The array of strings

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Add a String Array (String[]) value to the underlying message.

function updateI8

native void updateI8(
    String name,
    int fid,
    byte value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I8 (byte) value in the underlying message.

function updateU8

native void updateU8(
    String name,
    int fid,
    short value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U8 (byte) value in the underlying message.

function updateI16

native void updateI16(
    String name,
    int fid,
    short value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I16 (short) value in the underlying message.

function updateU16

native void updateU16(
    String name,
    int fid,
    int value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U16 (short) value in the underlying message.

function updateI32

native void updateI32(
    String name,
    int fid,
    int value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I32 (int) value in the underlying message.

function updateU32

native void updateU32(
    String name,
    int fid,
    long value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U32 (int) value in the underlying message.

function updateI64

native void updateI64(
    String name,
    int fid,
    long value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I64 (long) value in the underlying message.

function updateU64

native void updateU64(
    String name,
    int fid,
    long value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U64 (long) value in the underlying message.

function updateF32

native void updateF32(
    String name,
    int fid,
    float value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an F32 (float) value in the underlying message.

function updateF64

native void updateF64(
    String name,
    int fid,
    double value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an F64 (double) value in the underlying message.

function updateString

native void updateString(
    String name,
    int fid,
    String value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an String (Java String) value in the underlying message.

function updatePrice

native void updatePrice(
    String name,
    int fid,
    MamaPrice value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a MamaPrice value in the underlying message.

function updateBoolean

native void updateBoolean(
    String name,
    int fid,
    boolean value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a Boolean value in the underlying message.

function updateChar

native void updateChar(
    String name,
    int fid,
    char value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an Char value in the underlying message.

function updateDateTime

native void updateDateTime(
    String name,
    int fid,
    MamaDateTime value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an MamaDateTime value in the underlying message.

function updateArrayI8

native void updateArrayI8(
    String name,
    int fid,
    byte[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I8 (byte[]) value in the underlying message.

function updateArrayU8

native void updateArrayU8(
    String name,
    int fid,
    short[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U8 (short[]) value in the underlying message.

function updateArrayI16

native void updateArrayI16(
    String name,
    int fid,
    short[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I16 (short[]) value in the underlying message.

function updateArrayU16

native void updateArrayU16(
    String name,
    int fid,
    int[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U16 (int[]) value in the underlying message.

function updateArrayI32

native void updateArrayI32(
    String name,
    int fid,
    int[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I32 (int[]) value in the underlying message.

function updateArrayU32

native void updateArrayU32(
    String name,
    int fid,
    long[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U32 (long[]) value in the underlying message.

function updateArrayI64

native void updateArrayI64(
    String name,
    int fid,
    long[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an I64 (long[]) value in the underlying message.

function updateArrayU64

native void updateArrayU64(
    String name,
    int fid,
    long[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of a U64 (long[]) value in the underlying message.

function updateArrayF32

native void updateArrayF32(
    String name,
    int fid,
    float[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an F32 (float[]) value in the underlying message.

function updateArrayF64

native void updateArrayF64(
    String name,
    int fid,
    double[] value
)

Parameters:

• name The name of the field to be updated within the message
• fid The FID of the field to be updated within the message
• value The new value

Exceptions:

• MamaException will be thrown if the message pointer does not exist

Update the value of an F64 (double[]) value in the underlying message.

function getChar

inline char getChar(
    String name,
    int fid,
    char defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a char

Return the value of a Char field from the underlying message.

function getChar

inline char getChar(
    MamaFieldDescriptor fieldDesc,
    char defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a char

Return the value of a Char field from the underlying message.

function getI8

inline byte getI8(
    String name,
    int fid,
    byte defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a byte

Return the value of an I8 field from the underlying message.

function getI8

inline byte getI8(
    MamaFieldDescriptor fieldDesc,
    byte defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a byte

Return the value of an I8 field from the underlying message.

function getU8

inline short getU8(
    String name,
    int fid,
    short defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a short

Return the value of a U8 field from the underlying message.

function getU8

inline short getU8(
    MamaFieldDescriptor fieldDesc,
    short defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a short

Return the value of a U8 field from the underlying message.

function getI16

inline short getI16(
    String name,
    int fid,
    short defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a short

Return the value of an I16 field from the underlying message.

function getI16

inline short getI16(
    MamaFieldDescriptor fieldDesc,
    short defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a short

Return the value of an I16 field from the underlying message.

function getU16

inline int getU16(
    String name,
    int fid,
    int defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a int

Return the value of a U16 field from the underlying message.

function getU16

inline int getU16(
    MamaFieldDescriptor fieldDesc,
    int defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a int

Return the value of a U16 field from the underlying message.

function getI32

inline int getI32(
    String name,
    int fid,
    int defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a int

Return the value of an I32 field from the underlying message.

function getI32

inline int getI32(
    MamaFieldDescriptor fieldDesc,
    int defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a int

Return the value of an I32 field from the underlying message.

function getU32

inline long getU32(
    String name,
    int fid,
    long defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a long

Return the value of a U32 field from the underlying message.

function getU32

inline long getU32(
    MamaFieldDescriptor fieldDesc,
    long defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a long

Return the value of a U32 field from the underlying message.

function getI64

inline long getI64(
    String name,
    int fid,
    long defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a long

Return the value of an I64 field from the underlying message.

function getI64

inline long getI64(
    MamaFieldDescriptor fieldDesc,
    long defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a long

Return the value of an I64 field from the underlying message.

function getU64

inline long getU64(
    String name,
    int fid,
    long defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a long

Return the value of a U64 field from the underlying message.

function getU64

inline long getU64(
    MamaFieldDescriptor fieldDesc,
    long defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a long

Return the value of a U64 field from the underlying message.

function getF32

inline float getF32(
    String name,
    int fid,
    float defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a float

Return the value of an F32 field from the underlying message.

function getF32

inline float getF32(
    MamaFieldDescriptor fieldDesc,
    float defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a float

Return the value of an F32 field from the underlying message.

function getF64

inline double getF64(
    String name,
    int fid,
    double defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a double

Return the value of an F64 field from the underlying message.

function getF64

inline double getF64(
    MamaFieldDescriptor fieldDesc,
    double defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a double

Return the value of an F64 field from the underlying message.

function getString

inline String getString(
    String name,
    int fid,
    String defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a String

Return the value of a String field from the underlying message.

function getString

inline String getString(
    MamaFieldDescriptor fieldDesc,
    String defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a String

Return the value of a String field from the underlying message.

function getPrice

inline MamaPrice getPrice(
    String name,
    int fid,
    MamaPrice defaultValue
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a MamaPrice

Return the value of a MamaPrice field from the underlying message.

function getPrice

inline MamaPrice getPrice(
    MamaFieldDescriptor fieldDesc,
    MamaPrice defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a MamaPrice

Return the value of a MamaPrice field from the underlying message.

function getMsg

inline MamaMsg getMsg(
    MamaFieldDescriptor fieldDesc,
    MamaMsg defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a MamaMsg

Return the value of a MamaMsg field from the underlying message.

function getArrayI32

inline int[] getArrayI32(
    MamaFieldDescriptor fieldDesc,
    int[] defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a int[]

Return the value of an I32 Array field from the underlying message.

function getArrayMsg

inline MamaMsg[] getArrayMsg(
    MamaFieldDescriptor fieldDesc,
    MamaMsg[] defaultValue
)

Parameters:

• fieldDesc The MamaFieldDescriptor for the field within the message
• defaultValue The default value to use of no value is present

Return: The value as a MamaMsg[]

Return the value of a MamaMsg Array field from the underlying message.

function tryBoolean

native boolean tryBoolean(
    String name,
    int fid,
    MamaBoolean result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a Boolean field from the underlying message.

function tryBoolean

inline boolean tryBoolean(
    MamaFieldDescriptor field,
    MamaBoolean result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaBoolean field from the underlying message.

function tryChar

native boolean tryChar(
    String name,
    int fid,
    MamaChar result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaChar field from the underlying message.

function tryChar

inline boolean tryChar(
    MamaFieldDescriptor field,
    MamaChar result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaChar field from the underlying message.

function tryI8

native boolean tryI8(
    String name,
    int fid,
    MamaByte result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaByte field from the underlying message.

function tryI8

inline boolean tryI8(
    MamaFieldDescriptor field,
    MamaByte result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaByte field from the underlying message.

function tryU8

native boolean tryU8(
    String name,
    int fid,
    MamaShort result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaShort field from the underlying message.

function tryU8

inline boolean tryU8(
    MamaFieldDescriptor field,
    MamaShort result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaShort field from the underlying message.

function tryI16

native boolean tryI16(
    String name,
    int fid,
    MamaShort result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaShort field from the underlying message.

function tryI16

inline boolean tryI16(
    MamaFieldDescriptor field,
    MamaShort result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaShort field from the underlying message.

function tryU16

native boolean tryU16(
    String name,
    int fid,
    MamaInteger result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaInteger field from the underlying message.

function tryU16

inline boolean tryU16(
    MamaFieldDescriptor field,
    MamaInteger result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaInteger field from the underlying message.

function tryI32

native boolean tryI32(
    String name,
    int fid,
    MamaInteger result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaInteger field from the underlying message.

function tryI32

inline boolean tryI32(
    MamaFieldDescriptor field,
    MamaInteger result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaInteger field from the underlying message.

function tryU32

native boolean tryU32(
    String name,
    int fid,
    MamaLong result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaLong field from the underlying message.

function tryU32

inline boolean tryU32(
    MamaFieldDescriptor field,
    MamaLong result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaLong field from the underlying message.

function tryI64

native boolean tryI64(
    String name,
    int fid,
    MamaLong result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaLong field from the underlying message.

function tryI64

inline boolean tryI64(
    MamaFieldDescriptor field,
    MamaLong result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaLong field from the underlying message.

function tryU64

native boolean tryU64(
    String name,
    int fid,
    MamaLong result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaLong field from the underlying message.

function tryU64

inline boolean tryU64(
    MamaFieldDescriptor field,
    MamaLong result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaLong field from the underlying message.

function tryF32

native boolean tryF32(
    String name,
    int fid,
    MamaFloat result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaFloat field from the underlying message.

function tryF32

inline boolean tryF32(
    MamaFieldDescriptor field,
    MamaFloat result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaFloat field from the underlying message.

function tryF64

native boolean tryF64(
    String name,
    int fid,
    MamaDouble result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaDouble field from the underlying message.

function tryF64

inline boolean tryF64(
    MamaFieldDescriptor field,
    MamaDouble result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaDouble field from the underlying message.

function tryDateTime

inline boolean tryDateTime(
    MamaFieldDescriptor field,
    MamaDateTime result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaDateTime field from the underlying message.

function tryDateTime

native boolean tryDateTime(
    String name,
    int fid,
    MamaDateTime result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaDateTime field from the underlying message.

function tryPrice

inline boolean tryPrice(
    MamaFieldDescriptor field,
    MamaPrice result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaPrice field from the underlying message.

function tryPrice

native boolean tryPrice(
    String name,
    int fid,
    MamaPrice result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaPrice field from the underlying message.

function tryString

native boolean tryString(
    String name,
    int fid,
    MamaString result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaString field from the underlying message.

function tryString

inline boolean tryString(
    MamaFieldDescriptor field,
    MamaString result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaString field from the underlying message.

function tryOpaque

inline boolean tryOpaque(
    String name,
    int fid,
    MamaOpaque result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaOpaque field from the underlying message.

function tryOpaque

inline boolean tryOpaque(
    MamaFieldDescriptor field,
    MamaOpaque result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaOpaque field from the underlying message.

function tryMsg

inline boolean tryMsg(
    String name,
    int fid,
    MamaMessage result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaMessage field from the underlying message.

function tryMsg

inline boolean tryMsg(
    MamaFieldDescriptor field,
    MamaMessage result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaMessage field from the underlying message.

function tryArrayI32

inline boolean tryArrayI32(
    String name,
    int fid,
    MamaArrayInt result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaArrayInt field from the underlying message.

function tryArrayI32

inline boolean tryArrayI32(
    MamaFieldDescriptor field,
    MamaArrayInt result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaArrayInt field from the underlying message.

function tryArrayU16

inline boolean tryArrayU16(
    String name,
    int fid,
    MamaArrayInt result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaArrayInt field from the underlying message.

function tryArrayU16

inline boolean tryArrayU16(
    MamaFieldDescriptor field,
    MamaArrayInt result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaArrayInt field from the underlying message.

function tryArrayMsg

inline boolean tryArrayMsg(
    String name,
    int fid,
    MamaArrayMsg result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaArrayMsg field from the underlying message.

function tryArrayMsg

inline boolean tryArrayMsg(
    MamaFieldDescriptor field,
    MamaArrayMsg result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaArrayMsg field from the underlying message.

function tryArrayString

inline boolean tryArrayString(
    String name,
    int fid,
    MamaArrayString result
)

Parameters:

• name The name of the field within the message
• fid The FID of the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Try to get the value of a MamaArrayString field from the underlying message.

function tryArrayString

inline boolean tryArrayString(
    MamaFieldDescriptor field,
    MamaArrayString result
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• result The result (not modified if field not present)

Return: Boolean representing whether the field was present or not

Return the value of a MamaArrayMsg field from the underlying message.

function iterateFields

inline void iterateFields(
    MamaMsgFieldIterator iterator,
    MamaDictionary dictionary,
    Object closure
)

Parameters:

• iterator Callback object implementing the MamaMsgFieldIterator interface
• dictionary Optional MamaDictionary object
• closure Optional user supplied arbitrary closure data which will be passed back in onField()

Iterate over all of the fields within the message. The onField() method of the [MamaMsgFieldIterator](interfacecom_1_1wombat_1_1mama_1_1MamaMsgFieldIterator.html) instance will be invoked for each field in the underlying message.

function getFieldAsString

native String getFieldAsString(
    int fid,
    MamaDictionary dictionary
)

Parameters:

• fid The FID of the field
• dictionary Optional MamaDictionary object

Return: Return a String representation the field with the given fid

Return a String representation of the entire message.

function isFromInbox

native boolean isFromInbox()

Return: Boolean indicating whether this message is a p2p request

Return a String representation of the entire message.

function toString

native String toString()

Return: the String representation of the entire message.

Return a String representation of the entire message.

function toJsonString

native String toJsonString()

Return: the String representation of the entire message.

Return a json String representation of the entire message.

function toJsonString

inline String toJsonString(
    MamaDictionary dictionary
)

Return: the String representation of the entire message.

Return a json String representation of the entire message using field names from the dictionary.

function toNormalizedString

native String toNormalizedString()

Return: the String representation of the entire message.

Return a normalized String representation of the entire message.

function getPayloadType

native char getPayloadType()

Return: A MamaPayloadType indicating which message payload is used in the message.

Return as a character representation of the payload type used in the message.

function destroy

inline void destroy()

Destroy the internal state of the MamaMsg object. Needed for JNI so we know when to free the underlying C strucure. Should only be called if the client app has created the message. i.e. do not call on messages passed in the callbacks as these are managed internal to the MAMA API

function clear

native void clear()

Clear the message. All fields are removed

function copy

native void copy(
    MamaMsg rhs
)

Parameters:

• rhs The MamaMsg to be copied

Create a deep copy of the message.

function detach

native MamaMsg detach()

Detach the message. This will take a deep copy of the MamaMsg and transfer the ownership to the application and it will be the responsibility of the user to destroy.

function apply

native void apply(
    MamaMsg rhs
)

Parameters:

• rhs The MamaMsg to be used to update the current message

Update the MamaMsg with the fields of another MamaMsg.

function getField

inline MamaMsgField getField(
    MamaFieldDescriptor field,
    MamaDictionary dict
)

Parameters:

• field The MamaFieldDescriptor for the field within the message
• dict Optional MamaDictionary object

Return: The MamaMsgField or null

Get a specified field from a message, or null if not found.

function getField

inline MamaMsgField getField(
    String fieldName,
    int fid,
    MamaDictionary dict
)

Parameters:

• fieldName The name of the field within the message
• fid The FID of the field within the message
• dict Optional MamaDictionary object

Return: The MamaMsgField or null

Get a specified field from a message, or null if not found.

Protected Functions Documentation

function finalize

inline void finalize()

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