Wombat::MamaMsg

Class which encapsulates the messages used in the MAMA infrastructure

Inherits from Wombat.MamaWrapper, IDisposable

Public Functions

Protected Functions

Public Properties

Additional inherited members

Public Functions inherited from Wombat.MamaWrapper

Protected Functions inherited from Wombat.MamaWrapper

Protected Attributes inherited from Wombat.MamaWrapper

Public Functions Documentation

function MamaMsg

MamaMsg()

Create a msg using the default payload.

function MamaMsg

MamaMsg(
    mamaPayloadType payloadId
)

NOTE: This function has been deprecated in line with the deprecation of the mamaPayloadType enum. Create a msg using the payload specified. The payload ID to create the message for

function MamaMsg

MamaMsg(
    char payloadId
)

Create a msg using the payload specified. Char identifying the payload to create the msg for

function MamaMsg

MamaMsg(
    MamaPayloadBridge payloadBridge
)

Create a msg using the payload bridge specified.

Parameters:

• payloadBridge The payload bridge to create the message for

function MamaMsg

MamaMsg(
    MamaMsg mamaMsgSrc
)

Create a deep copy of a message.

function getByteBuffer

void getByteBuffer(
    ref byte[] byteBuffer,
    ref int size
)

function createFromBuffer

void createFromBuffer(
    byte[] byteBuffer,
    int size
)

function createForBridgeFromBuffer

void createForBridgeFromBuffer(
    byte[] byteBuffer,
    int size,
    MamaBridge bridgeImpl
)

function detach

MamaMsg detach()

function getType

mamaMsgType getType()

Extract the type

Return:

function getStatus

mamaMsgStatus getStatus()

Return the status

Return:

summary> Return the payload type /summary>

function getPayloadType

mamaPayloadType getPayloadType()

function iterateFields

void iterateFields(
    MamaMsgFieldIterator iterator,
    MamaDictionary dictionary,
    object closure
)

Invoke the specified callback for each field in the message.

Parameters:

• iterator
• dictionary
• closure

function clear

void clear()

Clear a msg. All fields are removed.

function destroy

void destroy()

Destroy a message and free any resources associated with it.

function getByteSize

int getByteSize()

Get the size of the underlying message in bytes. Only works for tibrvMsg and wombatmsg types.

function addBool

void addBool(
    string name,
    ushort fid,
    bool val
)

Add a new bool field.

function addChar

void addChar(
    string name,
    ushort fid,
    char val
)

Add a new char field.

function addI8

void addI8(
    string name,
    ushort fid,
    sbyte val
)

Add a new 8 bit signed int field.

function addU8

void addU8(
    string name,
    ushort fid,
    byte val
)

Add a new 8 bit unsigned int field.

function addI16

void addI16(
    string name,
    ushort fid,
    short val
)

Add a new 16 bit signed int field.

function addU16

void addU16(
    string name,
    ushort fid,
    ushort val
)

Add a new 16 bit unsigned int field.

function addI32

void addI32(
    string name,
    ushort fid,
    int val
)

Add a new 32 bit unsigned int field.

function addU32

void addU32(
    string name,
    ushort fid,
    uint val
)

Add a new 32 bit signed int field.

function addI64

void addI64(
    string name,
    ushort fid,
    long val
)

Add a new I64 field.

function addU64

void addU64(
    string name,
    ushort fid,
    ulong val
)

Add a new U64 field.

function addF32

void addF32(
    string name,
    ushort fid,
    float val
)

Add a new float (f32) field.

function addF64

void addF64(
    string name,
    ushort fid,
    double val
)

Add a new f64 field.

function addString

void addString(
    string name,
    ushort fid,
    string val
)

Add a string field.

function addOpaque

void addOpaque(
    string name,
    ushort fid,
    byte[] val
)

Add an opaque field.

function addDateTime

void addDateTime(
    string name,
    ushort fid,
    DateTime val
)

Add a MAMA date/time field.

function addPrice

void addPrice(
    string name,
    ushort fid,
    MamaPrice val
)

Add a MAMA price field.

function addMsg

void addMsg(
    string name,
    ushort fid,
    MamaMsg val
)

Add a MamaMsg to the msg

function addVectorBool

void addVectorBool(
    string name,
    ushort fid,
    bool[] val
)

Add an array of booleans to the message.

function addVectorChar

void addVectorChar(
    string name,
    ushort fid,
    char[] val
)

Add an array of characters to the message.

function addVectorI8

void addVectorI8(
    string name,
    ushort fid,
    sbyte[] val
)

Add an array of signed 8 bit integers to the message.

function addVectorU8

void addVectorU8(
    string name,
    ushort fid,
    byte[] val
)

Add an array of unsigned 8 bit integers to the message.

function addVectorI16

void addVectorI16(
    string name,
    ushort fid,
    short[] val
)

Add an array of signed 16 bit integers to the message.

function addVectorU16

void addVectorU16(
    string name,
    ushort fid,
    ushort[] val
)

Add an array of unsigned 16 bit integers to the message.

function addVectorI32

void addVectorI32(
    string name,
    ushort fid,
    int[] val
)

Add an array of signed 32 bit integers to the message.

function addVectorU32

void addVectorU32(
    string name,
    ushort fid,
    uint[] val
)

Add an array of unsigned 32 bit integers to the message.

function addVectorI64

void addVectorI64(
    string name,
    ushort fid,
    long[] val
)

Add an array of signed 64 bit integers to the message.

function addVectorU64

void addVectorU64(
    string name,
    ushort fid,
    ulong[] val
)

Add an array of unsigned 64 bit integers to the message.

function addVectorF32

void addVectorF32(
    string name,
    ushort fid,
    float[] val
)

Add an array of 32 bit floating point numbers to the message.

function addVectorF64

void addVectorF64(
    string name,
    ushort fid,
    double[] val
)

Add an array of 64 bit floating point numbers to the message.

function addVectorDateTime

void addVectorDateTime(
    string name,
    ushort fid,
    DateTime[] val
)

Add an array of timestamps to the message.

function updateBool

void updateBool(
    string name,
    ushort fid,
    bool val
)

Update the value of an existing bool field. If the field does not exist it is added.

function updateChar

void updateChar(
    string name,
    ushort fid,
    char val
)

Update the value of an existing char field. If the field does not exist it is added.

function updateI8

void updateI8(
    string name,
    ushort fid,
    sbyte val
)

Update the value of an existing I8 field. If the field does not exist it is added.

function updateU8

void updateU8(
    string name,
    ushort fid,
    byte val
)

Update the value of an existing U8 field. If the field does not exist it is added.

function updateI16

void updateI16(
    string name,
    ushort fid,
    short val
)

Update the value of an existing I16 field. If the field does not exist it is added.

function updateU16

void updateU16(
    string name,
    ushort fid,
    ushort val
)

Update the value of an existing U16 field. If the field does not exist it is added.

function updateI32

void updateI32(
    string name,
    ushort fid,
    int val
)

Update the value of an existing I32 field. If the field does not exist it is added.

function updateU32

void updateU32(
    string name,
    ushort fid,
    uint val
)

Update the value of an existing U32 field. If the field does not exist it is added.

function updateI64

void updateI64(
    string name,
    ushort fid,
    long val
)

Update the value of an existing I64 field. If the field does not exist it is added.

function updateU64

void updateU64(
    string name,
    ushort fid,
    ulong val
)

Update the value of an existing U64 field. If the field does not exist it is added.

function updateF32

void updateF32(
    string name,
    ushort fid,
    float val
)

Update the value of an existing float field. If the field does not exist it is added.

function updateF64

void updateF64(
    string name,
    ushort fid,
    double val
)

Update the value of an existing f64 field. If the field does not exist it is added.

function updateString

void updateString(
    string name,
    ushort fid,
    string val
)

Update the value of an existing string field. If the field does not exist it is added.

function updateOpaque

void updateOpaque(
    string name,
    ushort fid,
    byte[] val
)

Update an opaque field.

function updateDateTime

void updateDateTime(
    string name,
    ushort fid,
    DateTime val
)

Update a MAMA date/time field.

function updatePrice

void updatePrice(
    string name,
    ushort fid,
    MamaPrice val
)

Update a MAMA price field.

function updateVectorBool

void updateVectorBool(
    string name,
    ushort fid,
    bool[] val
)

Update an array of booleans.

function updateVectorChar

void updateVectorChar(
    string name,
    ushort fid,
    char[] val
)

Update an array of characters.

function updateVectorI8

void updateVectorI8(
    string name,
    ushort fid,
    sbyte[] val
)

Update an array of signed 8 bit integers.

function updateVectorU8

void updateVectorU8(
    string name,
    ushort fid,
    byte[] val
)

Update an array of unsigned 8 bit integers.

function updateVectorI16

void updateVectorI16(
    string name,
    ushort fid,
    short[] val
)

Update an array of signed 16 bit integers.

function updateVectorU16

void updateVectorU16(
    string name,
    ushort fid,
    ushort[] val
)

Update an array of unsigned 16 bit integers.

function updateVectorI32

void updateVectorI32(
    string name,
    ushort fid,
    int[] val
)

Update an array of signed 32 bit integers.

function updateVectorU32

void updateVectorU32(
    string name,
    ushort fid,
    uint[] val
)

Update an array of unsigned 32 bit integers.

function updateVectorI64

void updateVectorI64(
    string name,
    ushort fid,
    long[] val
)

Update an array of signed 64 bit integers.

function updateVectorU64

void updateVectorU64(
    string name,
    ushort fid,
    ulong[] val
)

Update an array of unsigned 64 bit integers.

function updateVectorF32

void updateVectorF32(
    string name,
    ushort fid,
    float[] val
)

Update an array of 32 bit floating point numbers.

function updateVectorF64

void updateVectorF64(
    string name,
    ushort fid,
    double[] val
)

Update an array of 64 bit floating point numbers.

function updateVectorDateTime

void updateVectorDateTime(
    string name,
    ushort fid,
    DateTime[] val
)

Update an array of timestamps.

function getBool

bool getBool(
    string name,
    ushort fid
)

Get a bool field.

function getBool

bool getBool(
    MamaFieldDescriptor descriptor
)

Get a bool field.

function getBool

bool getBool(
    string name,
    ushort fid,
    bool valueIfMissing
)

Get a bool field.

function getBool

bool getBool(
    MamaFieldDescriptor descriptor,
    bool valueIfMissing
)

Get a bool field.

function getChar

char getChar(
    string name,
    ushort fid
)

Get a char field.

function getChar

char getChar(
    MamaFieldDescriptor descriptor
)

Get a char field.

function getChar

char getChar(
    string name,
    ushort fid,
    char valueIfMissing
)

Get a char field.

function getChar

char getChar(
    MamaFieldDescriptor descriptor,
    char valueIfMissing
)

Get a char field.

function getI8

sbyte getI8(
    string name,
    ushort fid
)

Get a I8, signed 8 bit integer, field.

function getI8

sbyte getI8(
    MamaFieldDescriptor descriptor
)

Get a I8, signed 8 bit integer, field.

function getI8

sbyte getI8(
    string name,
    ushort fid,
    sbyte valueIfMissing
)

Get a I8, signed 8 bit integer, field.

function getI8

sbyte getI8(
    MamaFieldDescriptor descriptor,
    sbyte valueIfMissing
)

Get a I8, signed 8 bit integer, field.

function getU8

byte getU8(
    string name,
    ushort fid
)

Get a U8, unsigned 8 bit integer, field.

function getU8

byte getU8(
    MamaFieldDescriptor descriptor
)

Get a U8, unsigned 8 bit integer, field.

function getU8

byte getU8(
    string name,
    ushort fid,
    byte valueIfMissing
)

Get a U8, unsigned 8 bit integer, field.

function getU8

byte getU8(
    MamaFieldDescriptor descriptor,
    byte valueIfMissing
)

Get a U8, unsigned 8 bit integer, field.

function getI16

short getI16(
    string name,
    ushort fid
)

Get a I16, signed 16 bit integer, field.

function getI16

short getI16(
    MamaFieldDescriptor descriptor
)

Get a I16, signed 16 bit integer, field.

function getI16

short getI16(
    string name,
    ushort fid,
    short valueIfMissing
)

Get a I16, signed 16 bit integer, field.

function getI16

short getI16(
    MamaFieldDescriptor descriptor,
    short valueIfMissing
)

Get a I16, signed 16 bit integer, field.

function getU16

ushort getU16(
    string name,
    ushort fid
)

Get a U16, unsigned 16 bit integer, field.

function getU16

ushort getU16(
    MamaFieldDescriptor descriptor
)

Get a U16, unsigned 16 bit integer, field.

function getU16

ushort getU16(
    string name,
    ushort fid,
    ushort valueIfMissing
)

Get a U16, unsigned 16 bit integer, field.

function getU16

ushort getU16(
    MamaFieldDescriptor descriptor,
    ushort valueIfMissing
)

Get a U16, unsigned 16 bit integer, field.

function getI32

int getI32(
    string name,
    ushort fid
)

Get a I32, signed 32 bit integer, field.

function getI32

int getI32(
    MamaFieldDescriptor descriptor
)

Get a I32, signed 32 bit integer, field.

function getI32

int getI32(
    string name,
    ushort fid,
    int valueIfMissing
)

Get a I32, signed 32 bit integer, field.

function getI32

int getI32(
    MamaFieldDescriptor descriptor,
    int valueIfMissing
)

Get a I32, signed 32 bit integer, field.

function getU32

uint getU32(
    string name,
    ushort fid
)

Get a U32, unsigned 32 bit integer, field.

function getU32

uint getU32(
    MamaFieldDescriptor descriptor
)

Get a U32, unsigned 32 bit integer, field.

function getU32

uint getU32(
    string name,
    ushort fid,
    uint valueIfMissing
)

Get a U32, unsigned 32 bit integer, field.

function getU32

uint getU32(
    MamaFieldDescriptor descriptor,
    uint valueIfMissing
)

Get a U32, unsigned 32 bit integer, field.

function getI64

long getI64(
    string name,
    ushort fid
)

Get a I64, signed 64 bit integer, field.

function getI64

long getI64(
    MamaFieldDescriptor descriptor
)

Get a I64, signed 64 bit integer, field.

function getI64

long getI64(
    string name,
    ushort fid,
    long valueIfMissing
)

Get a I64, signed 64 bit integer, field.

function getI64

long getI64(
    MamaFieldDescriptor descriptor,
    long valueIfMissing
)

Get a I64, signed 64 bit integer, field.

function getU64

ulong getU64(
    string name,
    ushort fid
)

Get a U64, unsigned 64 bit integer, field.

function getU64

ulong getU64(
    MamaFieldDescriptor descriptor
)

Get a U64, unsigned 64 bit integer, field.

function getU64

ulong getU64(
    string name,
    ushort fid,
    ulong valueIfMissing
)

Get a U64, unsigned 64 bit integer, field.

function getU64

ulong getU64(
    MamaFieldDescriptor descriptor,
    ulong valueIfMissing
)

Get a U64, unsigned 64 bit integer, field.

function getF32

float getF32(
    string name,
    ushort fid
)

Get a float (f32) field.

function getF32

float getF32(
    MamaFieldDescriptor descriptor
)

Get a float (f32) field.

function getF32

float getF32(
    string name,
    ushort fid,
    float valueIfMissing
)

Get a float (f32) field.

function getF32

float getF32(
    MamaFieldDescriptor descriptor,
    float valueIfMissing
)

Get a float (f32) field.

function getF64

double getF64(
    string name,
    ushort fid
)

Get a F64 field.

function getF64

double getF64(
    MamaFieldDescriptor descriptor
)

Get a F64 field.

function getF64

double getF64(
    string name,
    ushort fid,
    double valueIfMissing
)

Get a F64 field.

function getF64

double getF64(
    MamaFieldDescriptor descriptor,
    double valueIfMissing
)

Get a F64 field.

function getString

string getString(
    string name,
    ushort fid
)

Get a string field.

function tryStringAnsi

bool tryStringAnsi(
    string name,
    ushort fid,
    ref IntPtr result
)

function tryStringAnsi

bool tryStringAnsi(
    MamaFieldDescriptor descriptor,
    ref IntPtr result
)

function getString

string getString(
    MamaFieldDescriptor descriptor
)

Get a string field.

function getString

string getString(
    string name,
    ushort fid,
    string valueIfMissing
)

Get a string field.

function getString

string getString(
    MamaFieldDescriptor descriptor,
    string valueIfMissing
)

Get a string field.

function getOpaque

byte[] getOpaque(
    string name,
    ushort fid
)

Get an opaque field.

function getOpaque

byte[] getOpaque(
    MamaFieldDescriptor descriptor
)

Get a opaque field.

function getOpaque

byte[] getOpaque(
    string name,
    ushort fid,
    byte[] valueIfMissing
)

Get a opaque field.

function getOpaque

byte[] getOpaque(
    MamaFieldDescriptor descriptor,
    byte[] valueIfMissing
)

Get a opaque field.

function getDateTime

DateTime getDateTime(
    string name,
    ushort fid
)

Get a MAMA date/time field.

function getDateTime

DateTime getDateTime(
    MamaFieldDescriptor descriptor
)

Get a MAMA date/time field.

function getDateTime

DateTime getDateTime(
    string name,
    ushort fid,
    DateTime valueIfMissing
)

Get a MAMA date/time field.

function getDateTime

DateTime getDateTime(
    MamaFieldDescriptor descriptor,
    DateTime valueIfMissing
)

Get a MAMA date/time field.

function getPrice

MamaPrice getPrice(
    string name,
    ushort fid
)

Get a MAMA price field.

function getPrice

MamaPrice getPrice(
    MamaFieldDescriptor descriptor
)

Get a MAMA price field.

function getPrice

MamaPrice getPrice(
    string name,
    ushort fid,
    MamaPrice valueIfMissing
)

Get a MAMA price field.

function getPrice

MamaPrice getPrice(
    MamaFieldDescriptor descriptor,
    MamaPrice valueIfMissing
)

Get a MAMA price field.

function getMsg

MamaMsg getMsg(
    string name,
    ushort fid
)

Get a submessage.

function getMsg

MamaMsg getMsg(
    MamaFieldDescriptor descriptor
)

Get a submessage.

function getMsg

MamaMsg getMsg(
    string name,
    ushort fid,
    MamaMsg valueIfMissing
)

Get a submessage.

Parameters:

• name
• fid
• valueIfMissing

Return:

function getMsg

MamaMsg getMsg(
    MamaFieldDescriptor descriptor,
    MamaMsg valueIfMissing
)

Get a submessage.

Parameters:

• descriptor
• valueIfMissing

Return:

function getField

MamaMsgField getField(
    string name,
    ushort fid
)

Get a MAMA msg field. The result contains the reusable field object of the nativeHandle object. Applications calling this method will receive the same reusable object for repeated calls on same nativeHandle object.

function getField

MamaMsgField getField(
    MamaFieldDescriptor descriptor
)

Get a MAMA msg field. The result contains the reusable field object of the nativeHandle object. Applications calling this method will receive the same reusable object for repeated calls on same nativeHandle object.

function getField

MamaMsgField getField(
    string name,
    ushort fid,
    MamaMsgField valueIfMissing
)

Get a MAMA msg field. The result contains the reusable field object of the nativeHandle object. Applications calling this method will receive the same reusable object for repeated calls on same nativeHandle object.

function getField

MamaMsgField getField(
    MamaFieldDescriptor descriptor,
    MamaMsgField valueIfMissing
)

Get a MAMA msg field. The result contains the reusable field object of the nativeHandle object. Applications calling this method will receive the same reusable object for repeated calls on same nativeHandle object.

function getVectorBool

bool[] getVectorBool(
    string name,
    ushort fid
)

Get a vector of booleans.

function getVectorBool

bool[] getVectorBool(
    MamaFieldDescriptor descriptor
)

Get a vector of booleans.

function getVectorBool

bool[] getVectorBool(
    string name,
    ushort fid,
    bool[] valueIfMissing
)

Get a vector of booleans.

function getVectorBool

bool[] getVectorBool(
    MamaFieldDescriptor descriptor,
    bool[] valueIfMissing
)

Get a vector of booleans.

function getVectorChar

char[] getVectorChar(
    string name,
    ushort fid
)

Get a vector of chars.

function getVectorChar

char[] getVectorChar(
    MamaFieldDescriptor descriptor
)

Get a vector of chars.

function getVectorChar

char[] getVectorChar(
    string name,
    ushort fid,
    char[] valueIfMissing
)

Get a vector of chars.

function getVectorChar

char[] getVectorChar(
    MamaFieldDescriptor descriptor,
    char[] valueIfMissing
)

Get a vector of chars.

function getVectorI8

sbyte[] getVectorI8(
    string name,
    ushort fid
)

Get a vector of signed 8 bit integers.

function getVectorI8

sbyte[] getVectorI8(
    MamaFieldDescriptor descriptor
)

Get a vector of signed 8 bit integers.

function getVectorI8

sbyte[] getVectorI8(
    string name,
    ushort fid,
    sbyte[] valueIfMissing
)

Get a vector of signed 8 bit integers.

function getVectorI8

sbyte[] getVectorI8(
    MamaFieldDescriptor descriptor,
    sbyte[] valueIfMissing
)

Get a vector of signed 8 bit integers.

function getVectorU8

byte[] getVectorU8(
    string name,
    ushort fid
)

Get a vector of unsigned 8 bit integers.

function getVectorU8

byte[] getVectorU8(
    MamaFieldDescriptor descriptor
)

Get a vector of unsigned 8 bit integers.

function getVectorU8

byte[] getVectorU8(
    string name,
    ushort fid,
    byte[] valueIfMissing
)

Get a vector of unsigned 8 bit integers.

function getVectorU8

byte[] getVectorU8(
    MamaFieldDescriptor descriptor,
    byte[] valueIfMissing
)

Get a vector of unsigned 8 bit integers.

function getVectorI16

short[] getVectorI16(
    string name,
    ushort fid
)

Get a vector of signed 16 bit integers.

function getVectorI16

short[] getVectorI16(
    MamaFieldDescriptor descriptor
)

Get a vector of signed 16 bit integers.

function getVectorI16

short[] getVectorI16(
    string name,
    ushort fid,
    short[] valueIfMissing
)

Get a vector of signed 16 bit integers.

function getVectorI16

short[] getVectorI16(
    MamaFieldDescriptor descriptor,
    short[] valueIfMissing
)

Get a vector of signed 16 bit integers.

function getVectorU16

ushort[] getVectorU16(
    string name,
    ushort fid
)

Get a vector of unsigned 16 bit integers.

function getVectorU16

ushort[] getVectorU16(
    MamaFieldDescriptor descriptor
)

Get a vector of unsigned 16 bit integers.

function getVectorU16

ushort[] getVectorU16(
    string name,
    ushort fid,
    ushort[] valueIfMissing
)

Get a vector of unsigned 16 bit integers.

function getVectorU16

ushort[] getVectorU16(
    MamaFieldDescriptor descriptor,
    ushort[] valueIfMissing
)

Get a vector of unsigned 16 bit integers.

function getVectorI32

int[] getVectorI32(
    string name,
    ushort fid
)

Get a vector of signed 32 bit integers.

function getVectorI32

int[] getVectorI32(
    MamaFieldDescriptor descriptor
)

Get a vector of signed 32 bit integers.

function getVectorI32

int[] getVectorI32(
    string name,
    ushort fid,
    int[] valueIfMissing
)

Get a vector of signed 32 bit integers.

function getVectorI32

int[] getVectorI32(
    MamaFieldDescriptor descriptor,
    int[] valueIfMissing
)

Get a vector of signed 32 bit integers.

function getVectorU32

uint[] getVectorU32(
    string name,
    ushort fid
)

Get a vector of unsigned 32 bit integers.

function getVectorU32

uint[] getVectorU32(
    MamaFieldDescriptor descriptor
)

Get a vector of unsigned 32 bit integers.

function getVectorU32

uint[] getVectorU32(
    string name,
    ushort fid,
    uint[] valueIfMissing
)

Get a vector of unsigned 32 bit integers.

function getVectorU32

uint[] getVectorU32(
    MamaFieldDescriptor descriptor,
    uint[] valueIfMissing
)

Get a vector of unsigned 32 bit integers.

function getVectorI64

long[] getVectorI64(
    string name,
    ushort fid
)

Get a vector of signed 64 bit integers.

function getVectorI64

long[] getVectorI64(
    MamaFieldDescriptor descriptor
)

Get a vector of signed 64 bit integers.

function getVectorI64

long[] getVectorI64(
    string name,
    ushort fid,
    long[] valueIfMissing
)

Get a vector of signed 64 bit integers.

function getVectorI64

long[] getVectorI64(
    MamaFieldDescriptor descriptor,
    long[] valueIfMissing
)

Get a vector of signed 64 bit integers.

function getVectorU64

ulong[] getVectorU64(
    string name,
    ushort fid
)

Get a vector of unsigned 64 bit integers.

function getVectorU64

ulong[] getVectorU64(
    MamaFieldDescriptor descriptor
)

Get a vector of unsigned 64 bit integers.

function getVectorU64

ulong[] getVectorU64(
    string name,
    ushort fid,
    ulong[] valueIfMissing
)

Get a vector of unsigned 64 bit integers.

function getVectorU64

ulong[] getVectorU64(
    MamaFieldDescriptor descriptor,
    ulong[] valueIfMissing
)

Get a vector of unsigned 64 bit integers.

function getVectorF32

float[] getVectorF32(
    string name,
    ushort fid
)

Get a vector of 32 bit floating point numbers.

function getVectorF32

float[] getVectorF32(
    MamaFieldDescriptor descriptor
)

Get a vector of 32 bit floating point numbers.

function getVectorF32

float[] getVectorF32(
    string name,
    ushort fid,
    float[] valueIfMissing
)

Get a vector of 32 bit floating point numbers.

function getVectorF32

float[] getVectorF32(
    MamaFieldDescriptor descriptor,
    float[] valueIfMissing
)

Get a vector of 32 bit floating point numbers.

function getVectorF64

double[] getVectorF64(
    string name,
    ushort fid
)

Get a vector of 64 bit floating point numbers.

function getVectorF64

double[] getVectorF64(
    MamaFieldDescriptor descriptor
)

Get a vector of 64 bit floating point numbers.

function getVectorF64

double[] getVectorF64(
    string name,
    ushort fid,
    double[] valueIfMissing
)

Get a vector of 64 bit floating point numbers.

function getVectorF64

double[] getVectorF64(
    MamaFieldDescriptor descriptor,
    double[] valueIfMissing
)

Get a vector of 64 bit floating point numbers.

function getVectorString

string[] getVectorString(
    string name,
    ushort fid
)

Get a vector of strings (char*).

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.

Exceptions:

• MamaException Thrown if the vector could not be found.

function getVectorString

string[] getVectorString(
    MamaFieldDescriptor descriptor
)

Get a vector of strings (char*).

function getVectorString

string[] getVectorString(
    string name,
    ushort fid,
    string[] valueIfMissing
)

Get a vector of strings (char*).

function getVectorString

string[] getVectorString(
    MamaFieldDescriptor descriptor,
    string[] valueIfMissing
)

Get a vector of strings (char*).

function getVectorDateTime

DateTime[] getVectorDateTime(
    string name,
    ushort fid
)

Get a vector of timestamps.

function getVectorDateTime

DateTime[] getVectorDateTime(
    MamaFieldDescriptor descriptor
)

Get a vector of timestamps.

function getVectorDateTime

DateTime[] getVectorDateTime(
    string name,
    ushort fid,
    DateTime[] valueIfMissing
)

Get a vector of timestamps.

function getVectorDateTime

DateTime[] getVectorDateTime(
    MamaFieldDescriptor descriptor,
    DateTime[] valueIfMissing
)

Get a vector of timestamps.

function getVectorPrice

MamaPrice[] getVectorPrice(
    string name,
    ushort fid
)

Get a vector of prices.

function getVectorPrice

MamaPrice[] getVectorPrice(
    MamaFieldDescriptor descriptor
)

Get a vector of prices.

function getVectorPrice

MamaPrice[] getVectorPrice(
    string name,
    ushort fid,
    MamaPrice[] valueIfMissing
)

Get a vector of prices.

function getVectorPrice

MamaPrice[] getVectorPrice(
    MamaFieldDescriptor descriptor,
    MamaPrice[] valueIfMissing
)

Get a vector of prices.

function getVectorMsg

MamaMsg[] getVectorMsg(
    string name,
    ushort fid
)

Get a vector of submessages.

function getVectorMsg

MamaMsg[] getVectorMsg(
    MamaFieldDescriptor descriptor
)

Get a vector of submessages.

function getVectorMsg

MamaMsg[] getVectorMsg(
    string name,
    ushort fid,
    MamaMsg[] valueIfMissing
)

Get a vector of submessages.

Parameters:

• name
• fid
• valueIfMissing

Return:

function getVectorMsg

MamaMsg[] getVectorMsg(
    MamaFieldDescriptor descriptor,
    MamaMsg[] valueIfMissing
)

Get a vector of submessages.

Parameters:

• descriptor
• valueIfMissing

Return:

function tryBool

bool tryBool(
    string name,
    ushort fid,
    ref bool result
)

Try to get a bool field.

function tryBool

bool tryBool(
    MamaFieldDescriptor descriptor,
    ref bool result
)

Try to get a bool field.

function tryChar

bool tryChar(
    string name,
    ushort fid,
    ref char result
)

Try to get a char field.

function tryChar

bool tryChar(
    MamaFieldDescriptor descriptor,
    ref char result
)

Try to get a char field.

function tryI8

bool tryI8(
    string name,
    ushort fid,
    ref sbyte result
)

Try to get a I8, signed 8 bit integer, field.

function tryI8

bool tryI8(
    MamaFieldDescriptor descriptor,
    ref sbyte result
)

Try to get a I8, signed 8 bit integer, field.

function tryU8

bool tryU8(
    string name,
    ushort fid,
    ref byte result
)

Try to get a I8, signed 8 bit integer, field.

function tryU8

bool tryU8(
    MamaFieldDescriptor descriptor,
    ref byte result
)

Try to get a I8, signed 8 bit integer, field.

function tryI16

bool tryI16(
    string name,
    ushort fid,
    ref short result
)

Try to get a I16, signed 16 bit integer, field.

function tryI16

bool tryI16(
    MamaFieldDescriptor descriptor,
    ref short result
)

Try to get a I16, signed 16 bit integer, field.

function tryU16

bool tryU16(
    string name,
    ushort fid,
    ref ushort result
)

Try to get a U16, unsigned 16 bit integer, field.

function tryU16

bool tryU16(
    MamaFieldDescriptor descriptor,
    ref ushort result
)

Try to get a U16, unsigned 16 bit integer, field.

function tryU32

bool tryU32(
    string name,
    ushort fid,
    ref uint result
)

Try to get a U32, unsigned 32 bit integer, field.

function tryU32

bool tryU32(
    MamaFieldDescriptor descriptor,
    ref uint result
)

Try to get a U32, unsigned 32 bit integer, field.

function tryI32

bool tryI32(
    string name,
    ushort fid,
    ref int result
)

Try to get a I32, signed 32 bit integer, field.

Parameters:

• name
• fid
• result

Return:

function tryI32

bool tryI32(
    MamaFieldDescriptor descriptor,
    ref int result
)

Try to get a I32, signed 32 bit integer, field.

Parameters:

• descriptor
• result

Return:

function tryI64

bool tryI64(
    string name,
    ushort fid,
    ref long result
)

function tryI64

bool tryI64(
    MamaFieldDescriptor descriptor,
    ref long result
)

function tryU64

bool tryU64(
    string name,
    ushort fid,
    ref ulong result
)

Try to get a U64, unsigned 64 bit integer, field.

function tryU64

bool tryU64(
    MamaFieldDescriptor descriptor,
    ref ulong result
)

Try to get a U64, unsigned 64 bit integer, field.

function tryF32

bool tryF32(
    string name,
    ushort fid,
    ref float result
)

Try to get a float (f32) field.

function tryF32

bool tryF32(
    MamaFieldDescriptor descriptor,
    ref float result
)

Try to get a float (f32) field.

function tryF64

bool tryF64(
    string name,
    ushort fid,
    ref double result
)

Try to get a f64 field.

function tryF64

bool tryF64(
    MamaFieldDescriptor descriptor,
    ref double result
)

Try to get a f64 field.

function tryString

bool tryString(
    string name,
    ushort fid,
    ref string result
)

Try to get a string field.

function tryString

bool tryString(
    MamaFieldDescriptor descriptor,
    ref string result
)

Try to get a string field.

function tryOpaque

bool tryOpaque(
    string name,
    ushort fid,
    ref byte[] result
)

Try to get an opaque field.

function tryOpaque

bool tryOpaque(
    MamaFieldDescriptor descriptor,
    ref byte[] result
)

Try to get an opaque field.

function tryDateTime

bool tryDateTime(
    string name,
    ushort fid,
    ref DateTime result
)

function tryDateTime

bool tryDateTime(
    MamaFieldDescriptor descriptor,
    ref DateTime result
)

function tryPrice

bool tryPrice(
    string name,
    ushort fid,
    ref MamaPrice result
)

Try to get a MAMA price field.

function tryPrice

bool tryPrice(
    string name,
    ushort fid,
    MamaPrice result
)

Try to get a MAMA price field.

function tryPrice

bool tryPrice(
    MamaFieldDescriptor descriptor,
    ref MamaPrice result
)

Try to get a MAMA price field.

function tryMsg

bool tryMsg(
    string name,
    ushort fid,
    ref MamaMsg result
)

Try to get a submessage.

function tryMsg

bool tryMsg(
    MamaFieldDescriptor descriptor,
    ref MamaMsg result
)

Try to get a submessage.

function tryVectorBool

bool tryVectorBool(
    string name,
    ushort fid,
    ref bool[] result
)

Try to get a vector of booleans.

function tryVectorBool

bool tryVectorBool(
    MamaFieldDescriptor descriptor,
    ref bool[] result
)

Try to get a vector of booleans.

function tryVectorChar

bool tryVectorChar(
    string name,
    ushort fid,
    ref char[] result
)

Try to get a vector of chars.

function tryVectorChar

bool tryVectorChar(
    MamaFieldDescriptor descriptor,
    ref char[] result
)

Try to get a vector of chars.

function tryVectorI8

bool tryVectorI8(
    string name,
    ushort fid,
    ref sbyte[] result
)

Try to get a vector of signed 8 bit integers.

function tryVectorI8

bool tryVectorI8(
    MamaFieldDescriptor descriptor,
    ref sbyte[] result
)

Try to get a vector of signed 8 bit integers.

function tryVectorU8

bool tryVectorU8(
    string name,
    ushort fid,
    ref byte[] result
)

Try to get a vector of unsigned 8 bit integers.

function tryVectorU8

bool tryVectorU8(
    MamaFieldDescriptor descriptor,
    ref byte[] result
)

Try to get a vector of unsigned 8 bit integers.

function tryVectorI16

bool tryVectorI16(
    string name,
    ushort fid,
    ref short[] result
)

Try to get a vector of signed 16 bit integers.

function tryVectorI16

bool tryVectorI16(
    MamaFieldDescriptor descriptor,
    ref short[] result
)

Try to get a vector of signed 16 bit integers.

function tryVectorU16

bool tryVectorU16(
    string name,
    ushort fid,
    ref ushort[] result
)

Try to get a vector of unsigned 16 bit integers.

function tryVectorU16

bool tryVectorU16(
    MamaFieldDescriptor descriptor,
    ref ushort[] result
)

Try to get a vector of unsigned 16 bit integers.

function tryVectorI32

bool tryVectorI32(
    string name,
    ushort fid,
    ref int[] result
)

Try to get a vector of signed 32 bit integers.

function tryVectorI32

bool tryVectorI32(
    MamaFieldDescriptor descriptor,
    ref int[] result
)

Try to get a vector of signed 32 bit integers.

function tryVectorU32

bool tryVectorU32(
    string name,
    ushort fid,
    ref uint[] result
)

Try to get a vector of unsigned 32 bit integers.

function tryVectorU32

bool tryVectorU32(
    MamaFieldDescriptor descriptor,
    ref uint[] result
)

Try to get a vector of unsigned 32 bit integers.

function tryVectorI64

bool tryVectorI64(
    string name,
    ushort fid,
    ref long[] result
)

Try get a vector of signed 64 bit integers.

function tryVectorI64

bool tryVectorI64(
    MamaFieldDescriptor descriptor,
    ref long[] result
)

Try get a vector of signed 64 bit integers.

function tryVectorU64

bool tryVectorU64(
    string name,
    ushort fid,
    ref ulong[] result
)

Try to get a vector of unsigned 64 bit integers.

function tryVectorU64

bool tryVectorU64(
    MamaFieldDescriptor descriptor,
    ref ulong[] result
)

Try to get a vector of unsigned 64 bit integers.

function tryVectorF32

bool tryVectorF32(
    string name,
    ushort fid,
    ref float[] result
)

Try to get a vector of 32 bit floating point numbers.

function tryVectorF32

bool tryVectorF32(
    MamaFieldDescriptor descriptor,
    ref float[] result
)

Try to get a vector of 32 bit floating point numbers.

function tryVectorF64

bool tryVectorF64(
    string name,
    ushort fid,
    ref double[] result
)

Try to get a vector of 64 bit floating point numbers.

function tryVectorF64

bool tryVectorF64(
    MamaFieldDescriptor descriptor,
    ref double[] result
)

Try to get a vector of 64 bit floating point numbers.

function tryVectorString

bool tryVectorString(
    MamaFieldDescriptor descriptor,
    ref string[] result
)

Try to get a vector of strings (char*).

function tryVectorDateTime

bool tryVectorDateTime(
    string name,
    ushort fid,
    ref DateTime[] result
)

Try to get a vector of timestamps.

function tryVectorDateTime

bool tryVectorDateTime(
    MamaFieldDescriptor descriptor,
    ref DateTime[] result
)

Try to get a vector of timestamps.

function tryVectorPrice

bool tryVectorPrice(
    MamaFieldDescriptor descriptor,
    ref MamaPrice[] result
)

Try to get a vector of prices.

function tryVectorMsg

bool tryVectorMsg(
    string name,
    ushort fid,
    ref MamaMsg[] result
)

function tryVectorMsg

bool tryVectorMsg(
    MamaFieldDescriptor descriptor,
    ref MamaMsg[] result
)

function tryField

bool tryField(
    string name,
    ushort fid,
    ref MamaMsgField result
)

Try to get a MAMA msg field. The result contains the reusable field object of the nativeHandle object. Applications calling this method will receive the same reusable object for repeated calls on same nativeHandle object.

function tryField

bool tryField(
    MamaFieldDescriptor descriptor,
    ref MamaMsgField result
)

Try to get a MAMA msg field. The result contains the reusable field object of the nativeHandle object. Applications calling this method will receive the same reusable object for repeated calls on same nativeHandle object.

function tryI32

bool tryI32(
    string name,
    ushort fid,
    ref NullableInt result
)

function tryI32

bool tryI32(
    MamaFieldDescriptor descriptor,
    ref NullableInt result
)

function tryI64

bool tryI64(
    string name,
    ushort fid,
    ref NullableLong result
)

function tryI64

bool tryI64(
    MamaFieldDescriptor descriptor,
    ref NullableLong result
)

function getNumFields

int getNumFields()

Returns the total number of fields in the message. Sub-messages count as a single field.

function ToString

override string ToString()

Return a string representation the message.

function ToJsonString

string ToJsonString()

Return a json string representation the message.

function ToJsonString

string ToJsonString(
    MamaDictionary dictionary
)

Return a json string representation the message.

function ToNormalizedString

string ToNormalizedString()

Return a normalized string representation the message.

function getEntitleCode

int getEntitleCode()

Get the entitle code for this message. The result defaults to 0 (no entitlement) if the field is not present.

function getSeqNum

uint getSeqNum()

Return the sequence

Return:

function typeForMsg

mamaMsgType typeForMsg()

Extract the type from the supplied message.

function stringForMsg

string stringForMsg()

Return the string for this message

function stringForType

string stringForType(
    mamaMsgType type
)

Return the type name.

function stringForStatus

string stringForStatus(
    mamaMsgStatus type
)

Return the status string

function getFieldAsString

string getFieldAsString(
    string name,
    ushort fid
)

Return the field value as string

function begin

void begin(
    ref MamaMsgIterator iterator
)

function end

void end(
    ref MamaMsgIterator iterator
)

function addVectorString

void addVectorString(
    string name,
    ushort fid,
    string[] val
)

Add an array of strings (char*) to the message.

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.
• val The array of strings to add.

Exceptions:

• ArgumentNullException Throw if the string array is null.
• ArgumentOutOfRangeException Throw if there are no items in the string array.

function addVectorPrice

void addVectorPrice(
    string name,
    ushort fid,
    MamaPrice[] val
)

Add an array of prices to the message.

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.
• val The array of messages to add.

Exceptions:

• ArgumentNullException Throw if the message array is null.
• ArgumentOutOfRangeException Throw if there are no items in the message array.

function addVectorMsg

void addVectorMsg(
    string name,
    ushort fid,
    MamaMsg[] val
)

Add an array of nativeHandle objects to the message.

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.
• val The array of messages to add.

Exceptions:

• ArgumentNullException Throw if the message array is null.
• ArgumentOutOfRangeException Throw if there are no items in the message array.

function updateVectorString

void updateVectorString(
    string name,
    ushort fid,
    string[] val
)

Update an array of strings (char*).

Parameters:

• name The field name, can be null or blank if the field Id is supplied.
• fid
• val The array of strings to add.

Exceptions:

• ArgumentNullException Throw if the string array is null.
• ArgumentOutOfRangeException Throw if there are no items in the string array.

function updateVectorPrice

void updateVectorPrice(
    string name,
    ushort fid,
    MamaPrice[] val
)

Update an array of prices.

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.
• val The array of messages to add.

Exceptions:

• ArgumentNullException Throw if the message array is null.
• ArgumentOutOfRangeException Throw if there are no items in the message array.

function updateVectorMsg

void updateVectorMsg(
    string name,
    ushort fid,
    MamaMsg[] val
)

Update an array of nativeHandle objects.

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.
• val The array of messages to add.

Exceptions:

• ArgumentNullException Throw if the message array is null.
• ArgumentOutOfRangeException Throw if there are no items in the message array.

function tryVectorString

bool tryVectorString(
    string name,
    ushort fid,
    ref string[] result
)

Try to get a vector of strings (char*).

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.
• result To return the array of strings.

Return: false if the field could not be found. Note that true is returned if an empty array is returned.

function tryVectorPrice

bool tryVectorPrice(
    string name,
    ushort fid,
    ref MamaPrice[] result
)

Try to get a vector of prices.

Parameters:

• fid The field id, can be 0 if the name is specified and field names are turned on.
• name The field name, can be null or blank if the field Id is supplied.
• result To return the array of prices.

Return: false if the field could not be found. Note that true is returned if an empty array is returned.

Protected Functions Documentation

function OnDispose

virtual override void OnDispose()

Reimplements: Wombat::MamaWrapper::OnDispose

function DestroyNativePeer

virtual override MamaStatus.mamaStatus DestroyNativePeer()

Return:

Reimplements: Wombat::MamaWrapper::DestroyNativePeer

Public Property Documentation

property isFromInbox

bool isFromInbox;

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