OpenMAMA C++ API
Wombat::MamaMsg Class Reference

MAMA message representation. More...

#include <MamaMsg.h>

Public Member Functions

 ~MamaMsg ()
 
 MamaMsg (void)
 
 MamaMsg (const MamaMsg &mm)
 
void create (void)
 Create the actual underlying wire format message. More...
 
 MAMADeprecated ("createForPayload has been deprecated, use dynamic loading instead!") void createForPayload(const char id)
 Create a mamaMsg. More...
 
void createForPayloadBridge (mamaPayloadBridge payloadBridge)
 Create a mamaMsg. More...
 
void createFromBuffer (const void *buffer, size_t bufferLength)
 Create a MamaMsg from the provided byte buffer. More...
 
void copy (const MamaMsg &rhs)
 Copy the message from another, severing all links to the original message. More...
 
MamaMsggetTempCopy ()
 Get a temporary copy of the mamaMsg so to be able to modify the content. More...
 
void applyMsg (const MamaMsg &msg)
 
void clear (void)
 Clear the message. More...
 
size_t getNumFields (void) const
 Returns the total number of fields in the message. More...
 
size_t getByteSize (void) const
 Get the message size in bytes. More...
 
bool getBoolean (const char *name, mama_fid_t fid) const
 Get a boolean field. More...
 
bool getBoolean (const MamaFieldDescriptor *fieldDesc) const
 Get a boolean field. More...
 
char getChar (const char *name, mama_fid_t fid) const
 Get a char field. More...
 
char getChar (const MamaFieldDescriptor *fieldDesc) const
 Get a char field. More...
 
mama_i8_t getI8 (const char *name, mama_fid_t fid) const
 Get an I8 field. More...
 
mama_i8_t getI8 (const MamaFieldDescriptor *fieldDesc) const
 Get a I8 field. More...
 
mama_u8_t getU8 (const char *name, mama_fid_t fid) const
 Get a U8 field. More...
 
mama_u8_t getU8 (const MamaFieldDescriptor *fieldDesc) const
 Get a U8 field. More...
 
mama_i16_t getI16 (const char *name, mama_fid_t fid) const
 Get an I16 field. More...
 
mama_i16_t getI16 (const MamaFieldDescriptor *fieldDesc) const
 Get an I16 field. More...
 
mama_u16_t getU16 (const char *name, mama_fid_t fid) const
 Get a U16 field. More...
 
mama_u16_t getU16 (const MamaFieldDescriptor *fieldDesc) const
 Get an U16 field. More...
 
mama_i32_t getI32 (const char *name, mama_fid_t fid) const
 Get an I32 field. More...
 
mama_i32_t getI32 (const MamaFieldDescriptor *fieldDesc) const
 Get a I32 field. More...
 
mama_u32_t getU32 (const char *name, mama_fid_t fid) const
 Get a U32 field. More...
 
mama_u32_t getU32 (const MamaFieldDescriptor *fieldDesc) const
 Get a U32 field. More...
 
mama_i64_t getI64 (const char *name, mama_fid_t fid) const
 Get a I64 field. More...
 
mama_i64_t getI64 (const MamaFieldDescriptor *fieldDesc) const
 Get a I64 field. More...
 
mama_u64_t getU64 (const char *name, mama_fid_t fid) const
 Get a U64 field. More...
 
mama_u64_t getU64 (const MamaFieldDescriptor *fieldDesc) const
 Get a U64 field. More...
 
mama_f32_t getF32 (const char *name, mama_fid_t fid) const
 Get a f32 field. More...
 
mama_f32_t getF32 (const MamaFieldDescriptor *fieldDesc) const
 Get a f32 field. More...
 
mama_f64_t getF64 (const char *name, mama_fid_t fid) const
 Get a f64 field. More...
 
mama_f64_t getF64 (const MamaFieldDescriptor *fieldDesc) const
 Get a f64 field. More...
 
const char * getString (const char *name, mama_fid_t fid) const
 Get a const char* field. More...
 
const char * getString (const MamaFieldDescriptor *fieldDesc) const
 Get a const char* field. More...
 
const void * getOpaque (const char *name, mama_fid_t fid, size_t &size) const
 Get an opaque field. More...
 
const void * getOpaque (const MamaFieldDescriptor *fieldDesc, size_t &size) const
 Get a const char* field. More...
 
void getDateTime (const char *name, mama_fid_t fid, MamaDateTime &result) const
 Get a MamaDateTime field. More...
 
void getDateTime (const MamaFieldDescriptor *fieldDesc, MamaDateTime &result) const
 Get a MamaDateTime field. More...
 
void getPrice (const char *name, mama_fid_t fid, MamaPrice &result) const
 Get a MamaPrice field. More...
 
void getPrice (const MamaFieldDescriptor *fieldDesc, MamaPrice &result) const
 Get a MamaPrice field. More...
 
const MamaMsggetMsg (const char *name, mama_fid_t fid) const
 Get a submessage field. More...
 
const MamaMsggetMsg (const MamaFieldDescriptor *fieldDesc) const
 Get a submessage field. More...
 
const char * getVectorChar (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of characters. More...
 
const char * getVectorChar (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of characters. More...
 
const mama_i8_t * getVectorI8 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of signed 8-bit integers. More...
 
const mama_i8_t * getVectorI8 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of signed 8-bit integers. More...
 
const mama_u8_t * getVectorU8 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of unsigned 8-bit integers. More...
 
const mama_u8_t * getVectorU8 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of unsigned 8-bit integers. More...
 
const mama_i16_t * getVectorI16 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of signed 16-bit integers. More...
 
const mama_i16_t * getVectorI16 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of signed 16-bit integers. More...
 
const mama_u16_t * getVectorU16 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of unsigned 16-bit integers. More...
 
const mama_u16_t * getVectorU16 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of unsigned 16-bit integers. More...
 
const mama_i32_t * getVectorI32 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of signed 32-bit integers. More...
 
const mama_i32_t * getVectorI32 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of signed 32-bit integers. More...
 
const mama_u32_t * getVectorU32 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of unsigned 32-bit integers. More...
 
const mama_u32_t * getVectorU32 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of unsigned 32-bit integers. More...
 
const mama_i64_t * getVectorI64 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of signed 64-bit integers. More...
 
const mama_i64_t * getVectorI64 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of signed 64-bit integers. More...
 
const mama_u64_t * getVectorU64 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of unsigned 64-bit integers. More...
 
const mama_u64_t * getVectorU64 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of unsigned 64-bit integers. More...
 
const mama_f32_t * getVectorF32 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of 32-bit floating point numbers. More...
 
const mama_f32_t * getVectorF32 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of 32-bit floating point numbers. More...
 
const mama_f64_t * getVectorF64 (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of 64-bit floating point numbers. More...
 
const mama_f64_t * getVectorF64 (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of 64-bit floating point numbers. More...
 
const MamaMsg ** getVectorMsg (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of submessages field. More...
 
const MamaMsg ** getVectorMsg (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of submessages. More...
 
const char ** getVectorString (const char *name, mama_fid_t fid, size_t &resultLen) const
 Get a vector of strings field. More...
 
const char ** getVectorString (const MamaFieldDescriptor *fieldDesc, size_t &resultLen) const
 Get a vector of submessages. More...
 
bool tryBoolean (const char *name, mama_fid_t fid, bool &result) const
 Try to get a boolean field. More...
 
bool tryBoolean (const MamaFieldDescriptor *field, bool &result) const
 Try to get a boolean field. More...
 
bool tryChar (const char *name, mama_fid_t fid, char &result) const
 Try to get a char field. More...
 
bool tryChar (const MamaFieldDescriptor *field, char &result) const
 Try to get a char field. More...
 
bool tryI8 (const char *name, mama_fid_t fid, mama_i8_t &result) const
 Try to get an unsigned 8 bit integer field. More...
 
bool tryI8 (const MamaFieldDescriptor *field, mama_i8_t &result) const
 Try to get an unsigned 8 bit field. More...
 
bool tryU8 (const char *name, mama_fid_t fid, mama_u8_t &result) const
 Try to get an unsigned 8 bit integer field. More...
 
bool tryU8 (const MamaFieldDescriptor *field, mama_u8_t &result) const
 Try to get an unsigned 8 bit field. More...
 
bool tryI16 (const char *name, mama_fid_t fid, mama_i16_t &result) const
 Try to get a signed 16 bit integer field. More...
 
bool tryI16 (const MamaFieldDescriptor *field, mama_i16_t &result) const
 Try to get a signed 16 bit field. More...
 
bool tryU16 (const char *name, mama_fid_t fid, mama_u16_t &result) const
 Try to get an unsigned 16 bit integer field. More...
 
bool tryU16 (const MamaFieldDescriptor *field, mama_u16_t &result) const
 Try to get an unsigned 16 bit field. More...
 
bool tryI32 (const char *name, mama_fid_t fid, mama_i32_t &result) const
 Try to get a signed 32 bit integer field. More...
 
bool tryI32 (const MamaFieldDescriptor *field, mama_i32_t &result) const
 Try to get a signed 32 bit integer field. More...
 
bool tryU32 (const char *name, mama_fid_t fid, mama_u32_t &result) const
 Try to get an unsigned 32 bit integer field. More...
 
bool tryU32 (const MamaFieldDescriptor *field, mama_u32_t &result) const
 Try to get an unsigned 32 bit integer field. More...
 
bool tryI64 (const char *name, mama_fid_t fid, mama_i64_t &result) const
 Try to get a signed 64 bit field. More...
 
bool tryI64 (const MamaFieldDescriptor *field, mama_i64_t &result) const
 Try to get a signed 64 bit field. More...
 
bool tryU64 (const char *name, mama_fid_t fid, mama_u64_t &result) const
 Try to get an unsigned 64 bit field. More...
 
bool tryU64 (const MamaFieldDescriptor *field, mama_u64_t &result) const
 Try to get an unsigned 64 bit field. More...
 
bool tryF32 (const char *name, mama_fid_t fid, mama_f32_t &result) const
 Try to get a f32 field. More...
 
bool tryF32 (const MamaFieldDescriptor *field, mama_f32_t &result) const
 Try to get a f32 field. More...
 
bool tryF64 (const char *name, mama_fid_t fid, mama_f64_t &result) const
 Try to get a f64 field. More...
 
bool tryF64 (const MamaFieldDescriptor *field, mama_f64_t &result) const
 Try to get a f64 field. More...
 
bool tryString (const char *name, mama_fid_t fid, const char *&result) const
 Try to get a string field. More...
 
bool tryString (const MamaFieldDescriptor *field, const char *&result) const
 Try to get a string field. More...
 
bool tryDateTime (const char *name, mama_fid_t fid, MamaDateTime &result) const
 Try to get a date/time field. More...
 
bool tryDateTime (const MamaFieldDescriptor *field, MamaDateTime &result) const
 Try to get a date/time field. More...
 
bool tryPrice (const char *name, mama_fid_t fid, MamaPrice &result) const
 Try to get a price field. More...
 
bool tryPrice (const MamaFieldDescriptor *field, MamaPrice &result) const
 Try to get a price field. More...
 
bool tryMsg (const char *name, mama_fid_t fid, const MamaMsg *&result) const
 Try to get a submessage field. More...
 
bool tryMsg (const MamaFieldDescriptor *field, const MamaMsg *&result) const
 Try to get a submessage field. More...
 
bool tryOpaque (const char *name, mama_fid_t fid, const void *&result, size_t &size) const
 Try to get a string field. More...
 
bool tryOpaque (const MamaFieldDescriptor *field, const void *&result, size_t &size) const
 Try to get a string field. More...
 
bool tryVectorChar (const char *name, mama_fid_t fid, const char *&result, size_t &resultLen) const
 Try to get a vector of characters. More...
 
bool tryVectorChar (const MamaFieldDescriptor *fieldDesc, const char *&result, size_t &resultLen) const
 Try to get a vector of characters. More...
 
bool tryVectorI8 (const char *name, mama_fid_t fid, const mama_i8_t *&result, size_t &resultLen) const
 Try to get a vector of signed 8-bit integers. More...
 
bool tryVectorI8 (const MamaFieldDescriptor *fieldDesc, const mama_i8_t *&result, size_t &resultLen) const
 Try to get a vector of signed 8-bit integers. More...
 
bool tryVectorU8 (const char *name, mama_fid_t fid, const mama_u8_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 8-bit integers. More...
 
bool tryVectorU8 (const MamaFieldDescriptor *fieldDesc, const mama_u8_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 8-bit integers. More...
 
bool tryVectorI16 (const char *name, mama_fid_t fid, const mama_i16_t *&result, size_t &resultLen) const
 Try to get a vector of signed 16-bit integers. More...
 
bool tryVectorI16 (const MamaFieldDescriptor *fieldDesc, const mama_i16_t *&result, size_t &resultLen) const
 Try to get a vector of signed 16-bit integers. More...
 
bool tryVectorU16 (const char *name, mama_fid_t fid, const mama_u16_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 16-bit integers. More...
 
bool tryVectorU16 (const MamaFieldDescriptor *fieldDesc, const mama_u16_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 16-bit integers. More...
 
bool tryVectorI32 (const char *name, mama_fid_t fid, const mama_i32_t *&result, size_t &resultLen) const
 Try to get a vector of signed 32-bit integers. More...
 
bool tryVectorI32 (const MamaFieldDescriptor *fieldDesc, const mama_i32_t *&result, size_t &resultLen) const
 Try to get a vector of signed 32-bit integers. More...
 
bool tryVectorU32 (const char *name, mama_fid_t fid, const mama_u32_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 32-bit integers. More...
 
bool tryVectorU32 (const MamaFieldDescriptor *fieldDesc, const mama_u32_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 32-bit integers. More...
 
bool tryVectorI64 (const char *name, mama_fid_t fid, const mama_i64_t *&result, size_t &resultLen) const
 Try to get a vector of signed 64-bit integers. More...
 
bool tryVectorI64 (const MamaFieldDescriptor *fieldDesc, const mama_i64_t *&result, size_t &resultLen) const
 Try to get a vector of signed 64-bit integers. More...
 
bool tryVectorU64 (const char *name, mama_fid_t fid, const mama_u64_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 64-bit integers. More...
 
bool tryVectorU64 (const MamaFieldDescriptor *fieldDesc, const mama_u64_t *&result, size_t &resultLen) const
 Try to get a vector of unsigned 64-bit integers. More...
 
bool tryVectorF32 (const char *name, mama_fid_t fid, const mama_f32_t *&result, size_t &resultLen) const
 Try to get a vector of 32-bit floating point numbers. More...
 
bool tryVectorF32 (const MamaFieldDescriptor *fieldDesc, const mama_f32_t *&result, size_t &resultLen) const
 Try to get a vector of 32-bit floating point numbers. More...
 
bool tryVectorF64 (const char *name, mama_fid_t fid, const mama_f64_t *&result, size_t &resultLen) const
 Try to get a vector of 64-bit floating point numbers. More...
 
bool tryVectorF64 (const MamaFieldDescriptor *fieldDesc, const mama_f64_t *&result, size_t &resultLen) const
 Try to get a vector of 64-bit floating point numbers. More...
 
bool tryVectorString (const char *name, mama_fid_t fid, const char **&result, size_t &resultLen) const
 Try to get a vector of strings. More...
 
bool tryVectorString (const MamaFieldDescriptor *fieldDesc, const char **&result, size_t &resultLen) const
 Try to get a vector of strings. More...
 
bool tryVectorMsg (const char *name, mama_fid_t fid, const MamaMsg **&result, size_t &resultLen) const
 Try to get a vector of submessages field. More...
 
bool tryVectorMsg (const MamaFieldDescriptor *fieldDesc, const MamaMsg **&result, size_t &resultLen) const
 Try to get a vector of submessages. More...
 
void addBoolean (const char *name, mama_fid_t fid, bool value)
 Add a new boolean field. More...
 
void addBoolean (const MamaFieldDescriptor *fieldDesc, bool value)
 Add a new boolean field. More...
 
void addChar (const char *name, mama_fid_t fid, char value)
 Add a new char field. More...
 
void addChar (const MamaFieldDescriptor *fieldDesc, char value)
 Add a new char field. More...
 
void addI8 (const char *name, mama_fid_t fid, mama_i8_t value)
 Add a new I8 field. More...
 
void addI8 (const MamaFieldDescriptor *fieldDesc, mama_i8_t value)
 Add a new I8 field. More...
 
void addI16 (const char *name, mama_fid_t fid, mama_i16_t value)
 Add a new I16 field. More...
 
void addI16 (const MamaFieldDescriptor *fieldDesc, mama_i16_t value)
 Add a new I16 field. More...
 
void addI32 (const char *name, mama_fid_t fid, mama_i32_t value)
 Add a new I32 field. More...
 
void addI32 (const MamaFieldDescriptor *fieldDesc, mama_i32_t value)
 Add a new I32 field. More...
 
void addI64 (const char *name, mama_fid_t fid, mama_i64_t value)
 Add a new I64 field. More...
 
void addI64 (const MamaFieldDescriptor *fieldDesc, mama_i64_t value)
 Add a new I64 field. More...
 
void addU8 (const char *name, mama_fid_t fid, mama_u8_t value)
 Add a new byte (U8) const field. More...
 
void addU8 (const MamaFieldDescriptor *fieldDesc, mama_u8_t value)
 Add a new U8 field. More...
 
void addU16 (const char *name, mama_fid_t fid, mama_u16_t value)
 Add a new short (U16) const field. More...
 
void addU16 (const MamaFieldDescriptor *fieldDesc, mama_u16_t value)
 Add a new U16 field. More...
 
void addU32 (const char *name, mama_fid_t fid, mama_u32_t value)
 Add a new int (U32) const field. More...
 
void addU32 (const MamaFieldDescriptor *fieldDesc, mama_u32_t value)
 Add a new U32 field. More...
 
void addU64 (const char *name, mama_fid_t fid, mama_u64_t value)
 Add a new int (U64) const field. More...
 
void addU64 (const MamaFieldDescriptor *fieldDesc, mama_u64_t value)
 Add a new U64 field. More...
 
void addF32 (const char *name, mama_fid_t fid, mama_f32_t value)
 Add a new F32 field. More...
 
void addF32 (const MamaFieldDescriptor *fieldDesc, mama_f32_t value)
 Add a new F32 field. More...
 
void addF64 (const char *name, mama_fid_t fid, mama_f64_t value)
 Add a new F64 field. More...
 
void addF64 (const MamaFieldDescriptor *fieldDesc, mama_f64_t value)
 Add a new F64 field. More...
 
void addString (const char *name, mama_fid_t fid, const char *value)
 Add a const char* field. More...
 
void addString (const MamaFieldDescriptor *fieldDesc, const char *value)
 Add a new const char* field. More...
 
void addDateTime (const char *name, mama_fid_t fid, const MamaDateTime &value)
 Add a date/time field. More...
 
void addDateTime (const MamaFieldDescriptor *fieldDesc, const MamaDateTime &value)
 Add a new date/time field. More...
 
void addPrice (const char *name, mama_fid_t fid, const MamaPrice &value)
 Add a price field. More...
 
void addPrice (const MamaFieldDescriptor *fieldDesc, const MamaPrice &value)
 Add a new price field. More...
 
void addOpaque (const char *name, mama_fid_t fid, const void *value, size_t size)
 Add an opaque field. More...
 
void addOpaque (const MamaFieldDescriptor *fieldDesc, const void *value, size_t size)
 Add an opaque field. More...
 
void addMsg (const char *name, mama_fid_t fid, MamaMsg *value)
 Add a MamaMsg object. More...
 
void addMsg (const MamaFieldDescriptor *fieldDesc, MamaMsg *value)
 Add a MamaMsg object. More...
 
void addVectorChar (const char *name, mama_fid_t fid, const char vectorValues[], size_t vectorLen)
 Add a vector of characters. More...
 
void addVectorChar (const MamaFieldDescriptor *fieldDesc, const char vectorValues[], size_t vectorLen)
 Add a vector of characters. More...
 
void addVectorI8 (const char *name, mama_fid_t fid, const mama_i8_t vectorValues[], size_t vectorLen)
 Add a vector of signed 8-bit integers. More...
 
void addVectorI8 (const MamaFieldDescriptor *fieldDesc, const mama_i8_t vectorValues[], size_t vectorLen)
 Add a vector of signed 8-bit integers. More...
 
void addVectorU8 (const char *name, mama_fid_t fid, const mama_u8_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 8-bit integers. More...
 
void addVectorU8 (const MamaFieldDescriptor *fieldDesc, const mama_u8_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 8-bit integers. More...
 
void addVectorI16 (const char *name, mama_fid_t fid, const mama_i16_t vectorValues[], size_t vectorLen)
 Add a vector of signed 16-bit integers. More...
 
void addVectorI16 (const MamaFieldDescriptor *fieldDesc, const mama_i16_t vectorValues[], size_t vectorLen)
 Add a vector of signed 16-bit integers. More...
 
void addVectorU16 (const char *name, mama_fid_t fid, const mama_u16_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 16-bit integers. More...
 
void addVectorU16 (const MamaFieldDescriptor *fieldDesc, const mama_u16_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 16-bit integers. More...
 
void addVectorI32 (const char *name, mama_fid_t fid, const mama_i32_t vectorValues[], size_t vectorLen)
 Add a vector of signed 32-bit integers. More...
 
void addVectorI32 (const MamaFieldDescriptor *fieldDesc, const mama_i32_t vectorValues[], size_t vectorLen)
 Add a vector of signed 32-bit integers. More...
 
void addVectorU32 (const char *name, mama_fid_t fid, const mama_u32_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 32-bit integers. More...
 
void addVectorU32 (const MamaFieldDescriptor *fieldDesc, const mama_u32_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 32-bit integers. More...
 
void addVectorI64 (const char *name, mama_fid_t fid, const mama_i64_t vectorValues[], size_t vectorLen)
 Add a vector of signed 64-bit integers. More...
 
void addVectorI64 (const MamaFieldDescriptor *fieldDesc, const mama_i64_t vectorValues[], size_t vectorLen)
 Add a vector of signed 64-bit integers. More...
 
void addVectorU64 (const char *name, mama_fid_t fid, const mama_u64_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 64-bit integers. More...
 
void addVectorU64 (const MamaFieldDescriptor *fieldDesc, const mama_u64_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 64-bit integers. More...
 
void addVectorF32 (const char *name, mama_fid_t fid, const mama_f32_t vectorValues[], size_t vectorLen)
 Add a vector of 32-bit floating point numbers. More...
 
void addVectorF32 (const MamaFieldDescriptor *fieldDesc, const mama_f32_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 32-bit integers. More...
 
void addVectorF64 (const char *name, mama_fid_t fid, const mama_f64_t vectorValues[], size_t vectorLen)
 Add a vector of 64-bit floating point numbers. More...
 
void addVectorF64 (const MamaFieldDescriptor *fieldDesc, const mama_f64_t vectorValues[], size_t vectorLen)
 Add a vector of unsigned 64-bit integers. More...
 
void addVectorString (const char *name, mama_fid_t fid, const char *vectorValues[], size_t vectorLen)
 Add a vector of strings. More...
 
void addVectorString (const MamaFieldDescriptor *fieldDesc, const char *vectorValues[], size_t vectorLen)
 Add a vector of strings. More...
 
void addVectorMsg (const char *name, mama_fid_t fid, MamaMsg *vectorValues[], size_t vectorLen)
 Add a vector of MamaMsg objects. More...
 
void addVectorMsg (const MamaFieldDescriptor *fieldDesc, MamaMsg *vectorValues[], size_t vectorLen)
 Add a vector of MamaMsg objects. More...
 
void updateBoolean (const char *name, mama_fid_t fid, bool value)
 Update the value of an existing boolean field. More...
 
void updateBoolean (const MamaFieldDescriptor *fieldDesc, bool value)
 Update the value of an existing boolean field. More...
 
void updateChar (const char *name, mama_fid_t fid, const char value)
 Update the value of an existing char field. More...
 
void updateChar (const MamaFieldDescriptor *fieldDesc, const char value)
 Update the value of an existing char field. More...
 
void updateI8 (const char *name, mama_fid_t fid, const mama_i8_t value)
 Update the value of an existing byte field. More...
 
void updateI8 (const MamaFieldDescriptor *fieldDesc, const mama_i8_t value)
 Update the value of an existing byte field. More...
 
void updateU8 (const char *name, mama_fid_t fid, const mama_u8_t value)
 Update the value of an existing U8 field. More...
 
void updateU8 (const MamaFieldDescriptor *fieldDesc, const mama_u8_t value)
 Update the value of an existing U8 field. More...
 
void updateI16 (const char *name, mama_fid_t fid, const mama_i16_t value)
 Update the value of an existing short field. More...
 
void updateI16 (const MamaFieldDescriptor *fieldDesc, const mama_i16_t value)
 Update the value of an existing short field. More...
 
void updateU16 (const char *name, mama_fid_t fid, const mama_u16_t value)
 Update the value of an existing U16 field. More...
 
void updateU16 (const MamaFieldDescriptor *fieldDesc, const mama_u16_t value)
 Update the value of an existing U16 field. More...
 
void updateI32 (const char *name, mama_fid_t fid, const mama_i32_t value)
 Update the value of an existing integer field. More...
 
void updateI32 (const MamaFieldDescriptor *fieldDesc, const mama_i32_t value)
 Update the value of an existing integer field. More...
 
void updateU32 (const char *name, mama_fid_t fid, const mama_u32_t value)
 Update the value of an existing U32 field. More...
 
void updateU32 (const MamaFieldDescriptor *fieldDesc, const mama_u32_t value)
 Update the value of an existing U32 field. More...
 
void updateI64 (const char *name, mama_fid_t fid, const mama_i64_t value)
 Update the value of an existing long field. More...
 
void updateI64 (const MamaFieldDescriptor *fieldDesc, const mama_i64_t value)
 Update the value of an existing long field. More...
 
void updateU64 (const char *name, mama_fid_t fid, const mama_u64_t value)
 Update the value of an existing U64 field. More...
 
void updateU64 (const MamaFieldDescriptor *fieldDesc, const mama_u64_t value)
 Update the value of an existing U64 field. More...
 
void updateF32 (const char *name, mama_fid_t fid, const mama_f32_t value)
 Update the value of an existing F32 field. More...
 
void updateF32 (const MamaFieldDescriptor *fieldDesc, const mama_f32_t value)
 Update the value of an existing F32 field. More...
 
void updateF64 (const char *name, mama_fid_t fid, const mama_f64_t value)
 Update the value of an existing F64 field. More...
 
void updateF64 (const MamaFieldDescriptor *fieldDesc, const mama_f64_t value)
 Update the value of an existing F64 field. More...
 
void updateString (const char *name, mama_fid_t fid, const char *value)
 Update the value of an existing const char* field. More...
 
void updateString (const MamaFieldDescriptor *fieldDesc, const char *value)
 Update the value of an existing string field. More...
 
void updateOpaque (const char *name, mama_fid_t fid, const void *value, size_t size)
 Update the value of an existing opaque field. More...
 
void updateOpaque (const MamaFieldDescriptor *fieldDesc, const void *value, size_t size)
 Update the value of an existing opaque field. More...
 
void updateDateTime (const char *name, mama_fid_t fid, const MamaDateTime &value)
 Update a date/time field. More...
 
void updateDateTime (const MamaFieldDescriptor *fieldDesc, const MamaDateTime &value)
 Update the value of an existing date/time field. More...
 
void updatePrice (const char *name, mama_fid_t fid, const MamaPrice &value)
 Update a price field. More...
 
void updatePrice (const MamaFieldDescriptor *fieldDesc, const MamaPrice &value)
 Update the value of an existing price field. More...
 
mamaMsgType getType (void) const
 Get the message type. More...
 
const char * getMsgTypeName (void) const
 Get a human readable type name. More...
 
mamaMsgStatus getStatus (void) const
 Get the msg status. More...
 
const char * getMsgStatusString (void) const
 Get human readable message status. More...
 
void iterateFields (MamaMsgFieldIterator &iterator, const MamaDictionary *dictionary, void *closure) const
 Iterate over all the fields. More...
 
const char * toString () const
 Return a const char * representation the message. More...
 
void getFieldAsString (const char *name, mama_fid_t fid, char *result, size_t maxResultLen) const
 Obtain a string representation the field with the given fid. More...
 
void getFieldAsString (const MamaFieldDescriptor *fieldDesc, char *result, size_t maxResultLen) const
 Obtain a string representation the field with the given fid. More...
 
MamaMsgFieldgetField (const char *name, mama_fid_t fid) const
 Obtain a the mamaMsgField with the given fid. More...
 
MamaMsgFieldgetField (const MamaFieldDescriptor *fieldDesc) const
 Obtain a the mamaMsgField with the given fid. More...
 
bool tryField (const char *name, mama_fid_t fid) const
 Test for the presence of the MamaMsgField with the given fid. More...
 
bool tryField (const MamaFieldDescriptor *fieldDesc) const
 Test for the presence of the MamaMsgField with the given field descriptor. More...
 
bool tryField (const char *name, mama_fid_t fid, MamaMsgField *result) const
 Try to obtain the MamaMsgField with the given fid. More...
 
bool tryField (const MamaFieldDescriptor *fieldDesc, MamaMsgField *result) const
 Try to obtain the MamaMsgField with the given field descriptor. More...
 
bool tryFieldAsString (const char *name, mama_fid_t fid, char *result, size_t maxResultLen) const
 Try to obtain a string representation the field with the given fid. More...
 
bool tryFieldAsString (const MamaFieldDescriptor *fieldDesc, char *result, size_t maxResultLen) const
 Try to obtain a string representation the field with the given fid. More...
 
void getByteBuffer (const void *&buffer, size_t &bufferLength) const
 Get the underlying message as an array of bytes. More...
 
MamaMsgdetach (void)
 Normally the Mama API owns incoming mamaMsg objects and they go out of scope and are freed when the message callback returns. More...
 
bool isFromInbox (void) const
 Whether this message is the result of a request needing a response. More...
 
mama_seqnum_t getSeqNum (void) const
 
bool getIsDefinitelyDuplicate (void) const
 Return true if this message is definitely a duplicate message. More...
 
bool getIsPossiblyDuplicate (void) const
 Return true if this message is possibly a duplicate message. More...
 
bool getIsPossiblyDelayed (void) const
 Return true if the message is possibly delayed. More...
 
bool getIsDefinitelyDelayed (void) const
 Return true if the message is delayed. More...
 
bool getIsOutOfSequence (void) const
 Return true when the FH sends the message out of sequence. More...
 
bool setNewBuffer (void *buffer, mama_size_t size)
 Sets a new for an existing mamaMsg using the provided byte buffer. More...
 
void * getNativeHandle (void) const
 Return the native middleware message handle. More...
 
void createFromMsg (mamaMsg msg, bool destroyMsg=false) const
 Create the message from an existing mamaMsg. More...
 
void setMsg (mamaMsg msg)
 Set the message to a different underlying C message. More...
 
const mamaMsg & getUnderlyingMsg (void) const
 Return const reference to underlying mamaMsg. More...
 
mamaMsg getUnderlyingMsg (void)
 Return the underlying mamaMsg (non const) More...
 
MAMAIgnoreDeprecatedOpen mamaPayloadType getPayloadType (void) const
 Return the type of the payload message (wombat message or, if using a non-wombat message payload, RV or FAST message). More...
 
MAMAIgnoreDeprecatedClose void * getNativeMsg (void)
 Get the native message structure for the underlying message. More...
 
MamaMsgFieldbegin (MamaMsgIterator &theIterator) const
 Sets a iterator to be used with existing mamaMsg. More...
 
mamaMsgReply getReplyHandle (void) const
 Get a copy of the reply Handle. More...
 

Static Public Member Functions

static void destroyReplyHandle (mamaMsgReply replyHandle)
 Destroy a copied reply Handle. More...
 

Detailed Description

MAMA message representation.

Field identifiers must be greater than 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 similar to TIBRV.

  • 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 throw a STATUS_NOT_FOUND exception.
  • If the fid supplied is 0, return the first field encountered with the supplied name or throw a STATUS_NOT_FOUND exception 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 API's 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.

Author
Michael Schonberg

Constructor & Destructor Documentation

§ ~MamaMsg()

Wombat::MamaMsg::~MamaMsg ( )

§ MamaMsg() [1/2]

Wombat::MamaMsg::MamaMsg ( void  )

§ MamaMsg() [2/2]

Wombat::MamaMsg::MamaMsg ( const MamaMsg mm)

Member Function Documentation

§ create()

void Wombat::MamaMsg::create ( void  )

Create the actual underlying wire format message.

This method will create a an underlying message native to the middleware being used. Tibrv: RV message LBM: Wombat Message TCP: Wombat Message

§ MAMADeprecated()

Wombat::MamaMsg::MAMADeprecated ( "createForPayload has been  deprecated,
use dynamic loading instead!"   
) const

Create a mamaMsg.

Parameters
idThe identifier of the payload to be used.

§ createForPayloadBridge()

void Wombat::MamaMsg::createForPayloadBridge ( mamaPayloadBridge  payloadBridge)

Create a mamaMsg.

Parameters
idThe payload bridge to be used.

§ createFromBuffer()

void Wombat::MamaMsg::createFromBuffer ( const void *  buffer,
size_t  bufferLength 
)

Create a MamaMsg from the provided byte buffer.

The application is responsible for destroying the message. In all cases the buffer is copied as the message is constructed.

Any transport differences are detailed below.

rv: The bufferLength parameter is not required.

Note: wombatmsg format is not currently supported on tibrv transports. At the moment a buffer containing the wire format for each of these transports is expected to be passed to the function.

Parameters
bufferThe byte array containing the wire format of the message
bufferLengthThe length, in bytes, of the supplied buffer
Returns
mama_status The outcome of the operation

§ copy()

void Wombat::MamaMsg::copy ( const MamaMsg rhs)

Copy the message from another, severing all links to the original message.

§ getTempCopy()

MamaMsg* Wombat::MamaMsg::getTempCopy ( )

Get a temporary copy of the mamaMsg so to be able to modify the content.

If the message can be modified directly, the message itself is returned. If the message cannot be modified then only one copy is performed the first time this method is called and then the same copy is returned when this method is called again. The copy has the same life time of the original message.

Returns
The message copy.

§ applyMsg()

void Wombat::MamaMsg::applyMsg ( const MamaMsg msg)

§ clear()

void Wombat::MamaMsg::clear ( void  )

Clear the message.

All fields are removed.

§ getNumFields()

size_t Wombat::MamaMsg::getNumFields ( void  ) const

Returns the total number of fields in the message.

Sub-messages count as a single field.

Returns
The number of fields in the message.

§ getByteSize()

size_t Wombat::MamaMsg::getByteSize ( void  ) const

Get the message size in bytes.

Supported with the following transports: tibrv LBT

Returns
The number of bytes in the message

§ getBoolean() [1/2]

bool Wombat::MamaMsg::getBoolean ( const char *  name,
mama_fid_t  fid 
) const

Get a boolean field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getBoolean() [2/2]

bool Wombat::MamaMsg::getBoolean ( const MamaFieldDescriptor fieldDesc) const

Get a boolean field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getChar() [1/2]

char Wombat::MamaMsg::getChar ( const char *  name,
mama_fid_t  fid 
) const

Get a char field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getChar() [2/2]

char Wombat::MamaMsg::getChar ( const MamaFieldDescriptor fieldDesc) const

Get a char field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getI8() [1/2]

mama_i8_t Wombat::MamaMsg::getI8 ( const char *  name,
mama_fid_t  fid 
) const

Get an I8 field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getI8() [2/2]

mama_i8_t Wombat::MamaMsg::getI8 ( const MamaFieldDescriptor fieldDesc) const

Get a I8 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getU8() [1/2]

mama_u8_t Wombat::MamaMsg::getU8 ( const char *  name,
mama_fid_t  fid 
) const

Get a U8 field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getU8() [2/2]

mama_u8_t Wombat::MamaMsg::getU8 ( const MamaFieldDescriptor fieldDesc) const

Get a U8 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getI16() [1/2]

mama_i16_t Wombat::MamaMsg::getI16 ( const char *  name,
mama_fid_t  fid 
) const

Get an I16 field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getI16() [2/2]

mama_i16_t Wombat::MamaMsg::getI16 ( const MamaFieldDescriptor fieldDesc) const

Get an I16 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getU16() [1/2]

mama_u16_t Wombat::MamaMsg::getU16 ( const char *  name,
mama_fid_t  fid 
) const

Get a U16 field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getU16() [2/2]

mama_u16_t Wombat::MamaMsg::getU16 ( const MamaFieldDescriptor fieldDesc) const

Get an U16 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getI32() [1/2]

mama_i32_t Wombat::MamaMsg::getI32 ( const char *  name,
mama_fid_t  fid 
) const

Get an I32 field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getI32() [2/2]

mama_i32_t Wombat::MamaMsg::getI32 ( const MamaFieldDescriptor fieldDesc) const

Get a I32 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getU32() [1/2]

mama_u32_t Wombat::MamaMsg::getU32 ( const char *  name,
mama_fid_t  fid 
) const

Get a U32 field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getU32() [2/2]

mama_u32_t Wombat::MamaMsg::getU32 ( const MamaFieldDescriptor fieldDesc) const

Get a U32 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getI64() [1/2]

mama_i64_t Wombat::MamaMsg::getI64 ( const char *  name,
mama_fid_t  fid 
) const

Get a I64 field.

Parameters
nameThe name
fidThe field identifier.
Returns
The field value as a long.

§ getI64() [2/2]

mama_i64_t Wombat::MamaMsg::getI64 ( const MamaFieldDescriptor fieldDesc) const

Get a I64 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getU64() [1/2]

mama_u64_t Wombat::MamaMsg::getU64 ( const char *  name,
mama_fid_t  fid 
) const

Get a U64 field.

Parameters
nameThe name
fidThe field identifier
Returns
The integer value.

§ getU64() [2/2]

mama_u64_t Wombat::MamaMsg::getU64 ( const MamaFieldDescriptor fieldDesc) const

Get a U64 field.

Parameters
fieldDescThe field descriptor
Returns
The integer value.

§ getF32() [1/2]

mama_f32_t Wombat::MamaMsg::getF32 ( const char *  name,
mama_fid_t  fid 
) const

Get a f32 field.

Parameters
nameThe name.
fidThe field identifier.
Returns
The double value.

§ getF32() [2/2]

mama_f32_t Wombat::MamaMsg::getF32 ( const MamaFieldDescriptor fieldDesc) const

Get a f32 field.

Parameters
fieldDescThe field descriptor
Returns
The double value.

§ getF64() [1/2]

mama_f64_t Wombat::MamaMsg::getF64 ( const char *  name,
mama_fid_t  fid 
) const

Get a f64 field.

Parameters
nameThe name.
fidThe field identifier.
Returns
The double value.

§ getF64() [2/2]

mama_f64_t Wombat::MamaMsg::getF64 ( const MamaFieldDescriptor fieldDesc) const

Get a f64 field.

Parameters
fieldDescThe field descriptor
Returns
The double value.

§ getString() [1/2]

const char* Wombat::MamaMsg::getString ( const char *  name,
mama_fid_t  fid 
) const

Get a const char* field.

Parameters
nameThe field name.
fidThe field identifier.
Returns
The string value. The return value points to the string inside the mamaMsg object. This piece of memory is owned by the object and does not need to be explicitly freed.

§ getString() [2/2]

const char* Wombat::MamaMsg::getString ( const MamaFieldDescriptor fieldDesc) const

Get a const char* field.

Parameters
fieldDescPointer to the field descriptor
Returns
The string value. The return value points to the string inside the mamaMsg object. This piece of memory is owned by the object and does not need to be explicitly freed.

§ getOpaque() [1/2]

const void* Wombat::MamaMsg::getOpaque ( const char *  name,
mama_fid_t  fid,
size_t &  size 
) const

Get an opaque field.

Parameters
nameThe field name.
fidThe field identifier.
[out]sizeThe opaque size in bytes.
Returns
the string value.

§ getOpaque() [2/2]

const void* Wombat::MamaMsg::getOpaque ( const MamaFieldDescriptor fieldDesc,
size_t &  size 
) const

Get a const char* field.

Parameters
fieldDescThe field descriptor
[out]sizeThe opaque size in bytes.
Returns
The double value.

§ getDateTime() [1/2]

void Wombat::MamaMsg::getDateTime ( const char *  name,
mama_fid_t  fid,
MamaDateTime result 
) const

Get a MamaDateTime field.

Parameters
nameThe field name.
fidThe field identifier.
result(out) the date/time.

§ getDateTime() [2/2]

void Wombat::MamaMsg::getDateTime ( const MamaFieldDescriptor fieldDesc,
MamaDateTime result 
) const

Get a MamaDateTime field.

Parameters
fieldDescThe field descriptor
result(out) the date/time.

§ getPrice() [1/2]

void Wombat::MamaMsg::getPrice ( const char *  name,
mama_fid_t  fid,
MamaPrice result 
) const

Get a MamaPrice field.

Parameters
nameThe field name.
fidThe field identifier.
result(out) the date/time.

§ getPrice() [2/2]

void Wombat::MamaMsg::getPrice ( const MamaFieldDescriptor fieldDesc,
MamaPrice result 
) const

Get a MamaPrice field.

Parameters
fieldDescThe field descriptor
result(out) the date/time.

§ getMsg() [1/2]

const MamaMsg* Wombat::MamaMsg::getMsg ( const char *  name,
mama_fid_t  fid 
) const

Get a submessage field.

Parameters
nameThe field name.
fidThe field identifier.
Returns
The submessage.

§ getMsg() [2/2]

const MamaMsg* Wombat::MamaMsg::getMsg ( const MamaFieldDescriptor fieldDesc) const

Get a submessage field.

Parameters
fieldDescThe field descriptor
Returns
The vector.

§ getVectorChar() [1/2]

const char* Wombat::MamaMsg::getVectorChar ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of characters.

(Note: prefer using string fields or opaque fields over a vector of characters.)

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorChar() [2/2]

const char* Wombat::MamaMsg::getVectorChar ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of characters.

(Note: prefer using string fields or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI8() [1/2]

const mama_i8_t* Wombat::MamaMsg::getVectorI8 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of signed 8-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI8() [2/2]

const mama_i8_t* Wombat::MamaMsg::getVectorI8 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of signed 8-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU8() [1/2]

const mama_u8_t* Wombat::MamaMsg::getVectorU8 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of unsigned 8-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU8() [2/2]

const mama_u8_t* Wombat::MamaMsg::getVectorU8 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of unsigned 8-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI16() [1/2]

const mama_i16_t* Wombat::MamaMsg::getVectorI16 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of signed 16-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI16() [2/2]

const mama_i16_t* Wombat::MamaMsg::getVectorI16 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of signed 16-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU16() [1/2]

const mama_u16_t* Wombat::MamaMsg::getVectorU16 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of unsigned 16-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU16() [2/2]

const mama_u16_t* Wombat::MamaMsg::getVectorU16 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of unsigned 16-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI32() [1/2]

const mama_i32_t* Wombat::MamaMsg::getVectorI32 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of signed 32-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI32() [2/2]

const mama_i32_t* Wombat::MamaMsg::getVectorI32 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of signed 32-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU32() [1/2]

const mama_u32_t* Wombat::MamaMsg::getVectorU32 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of unsigned 32-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU32() [2/2]

const mama_u32_t* Wombat::MamaMsg::getVectorU32 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of unsigned 32-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI64() [1/2]

const mama_i64_t* Wombat::MamaMsg::getVectorI64 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of signed 64-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorI64() [2/2]

const mama_i64_t* Wombat::MamaMsg::getVectorI64 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of signed 64-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU64() [1/2]

const mama_u64_t* Wombat::MamaMsg::getVectorU64 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of unsigned 64-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorU64() [2/2]

const mama_u64_t* Wombat::MamaMsg::getVectorU64 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of unsigned 64-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorF32() [1/2]

const mama_f32_t* Wombat::MamaMsg::getVectorF32 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of 32-bit floating point numbers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorF32() [2/2]

const mama_f32_t* Wombat::MamaMsg::getVectorF32 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of 32-bit floating point numbers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorF64() [1/2]

const mama_f64_t* Wombat::MamaMsg::getVectorF64 ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of 64-bit floating point numbers.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorF64() [2/2]

const mama_f64_t* Wombat::MamaMsg::getVectorF64 ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of 64-bit floating point numbers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorMsg() [1/2]

const MamaMsg** Wombat::MamaMsg::getVectorMsg ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of submessages field.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorMsg() [2/2]

const MamaMsg** Wombat::MamaMsg::getVectorMsg ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of submessages.

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorString() [1/2]

const char** Wombat::MamaMsg::getVectorString ( const char *  name,
mama_fid_t  fid,
size_t &  resultLen 
) const

Get a vector of strings field.

The vector is deleted with the message and overwritten by subsequent calls to getVectorString.

Parameters
nameThe field name.
fidThe field identifier.
resultLen(out) the size of the vector.
Returns
The vector.

§ getVectorString() [2/2]

const char** Wombat::MamaMsg::getVectorString ( const MamaFieldDescriptor fieldDesc,
size_t &  resultLen 
) const

Get a vector of submessages.

The vector is deleted with the message and overwritten by subsequent calls to getVectorString.

Parameters
fieldDescThe field descriptor
resultLen(out) the size of the vector.
Returns
The vector.

§ tryBoolean() [1/2]

bool Wombat::MamaMsg::tryBoolean ( const char *  name,
mama_fid_t  fid,
bool &  result 
) const

Try to get a boolean field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryBoolean() [2/2]

bool Wombat::MamaMsg::tryBoolean ( const MamaFieldDescriptor field,
bool &  result 
) const

Try to get a boolean field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryChar() [1/2]

bool Wombat::MamaMsg::tryChar ( const char *  name,
mama_fid_t  fid,
char &  result 
) const

Try to get a char field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryChar() [2/2]

bool Wombat::MamaMsg::tryChar ( const MamaFieldDescriptor field,
char &  result 
) const

Try to get a char field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryI8() [1/2]

bool Wombat::MamaMsg::tryI8 ( const char *  name,
mama_fid_t  fid,
mama_i8_t &  result 
) const

Try to get an unsigned 8 bit integer field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryI8() [2/2]

bool Wombat::MamaMsg::tryI8 ( const MamaFieldDescriptor field,
mama_i8_t &  result 
) const

Try to get an unsigned 8 bit field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryU8() [1/2]

bool Wombat::MamaMsg::tryU8 ( const char *  name,
mama_fid_t  fid,
mama_u8_t &  result 
) const

Try to get an unsigned 8 bit integer field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryU8() [2/2]

bool Wombat::MamaMsg::tryU8 ( const MamaFieldDescriptor field,
mama_u8_t &  result 
) const

Try to get an unsigned 8 bit field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryI16() [1/2]

bool Wombat::MamaMsg::tryI16 ( const char *  name,
mama_fid_t  fid,
mama_i16_t &  result 
) const

Try to get a signed 16 bit integer field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryI16() [2/2]

bool Wombat::MamaMsg::tryI16 ( const MamaFieldDescriptor field,
mama_i16_t &  result 
) const

Try to get a signed 16 bit field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryU16() [1/2]

bool Wombat::MamaMsg::tryU16 ( const char *  name,
mama_fid_t  fid,
mama_u16_t &  result 
) const

Try to get an unsigned 16 bit integer field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryU16() [2/2]

bool Wombat::MamaMsg::tryU16 ( const MamaFieldDescriptor field,
mama_u16_t &  result 
) const

Try to get an unsigned 16 bit field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryI32() [1/2]

bool Wombat::MamaMsg::tryI32 ( const char *  name,
mama_fid_t  fid,
mama_i32_t &  result 
) const

Try to get a signed 32 bit integer field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryI32() [2/2]

bool Wombat::MamaMsg::tryI32 ( const MamaFieldDescriptor field,
mama_i32_t &  result 
) const

Try to get a signed 32 bit integer field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryU32() [1/2]

bool Wombat::MamaMsg::tryU32 ( const char *  name,
mama_fid_t  fid,
mama_u32_t &  result 
) const

Try to get an unsigned 32 bit integer field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryU32() [2/2]

bool Wombat::MamaMsg::tryU32 ( const MamaFieldDescriptor field,
mama_u32_t &  result 
) const

Try to get an unsigned 32 bit integer field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryI64() [1/2]

bool Wombat::MamaMsg::tryI64 ( const char *  name,
mama_fid_t  fid,
mama_i64_t &  result 
) const

Try to get a signed 64 bit field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryI64() [2/2]

bool Wombat::MamaMsg::tryI64 ( const MamaFieldDescriptor field,
mama_i64_t &  result 
) const

Try to get a signed 64 bit field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryU64() [1/2]

bool Wombat::MamaMsg::tryU64 ( const char *  name,
mama_fid_t  fid,
mama_u64_t &  result 
) const

Try to get an unsigned 64 bit field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryU64() [2/2]

bool Wombat::MamaMsg::tryU64 ( const MamaFieldDescriptor field,
mama_u64_t &  result 
) const

Try to get an unsigned 64 bit field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryF32() [1/2]

bool Wombat::MamaMsg::tryF32 ( const char *  name,
mama_fid_t  fid,
mama_f32_t &  result 
) const

Try to get a f32 field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryF32() [2/2]

bool Wombat::MamaMsg::tryF32 ( const MamaFieldDescriptor field,
mama_f32_t &  result 
) const

Try to get a f32 field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryF64() [1/2]

bool Wombat::MamaMsg::tryF64 ( const char *  name,
mama_fid_t  fid,
mama_f64_t &  result 
) const

Try to get a f64 field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryF64() [2/2]

bool Wombat::MamaMsg::tryF64 ( const MamaFieldDescriptor field,
mama_f64_t &  result 
) const

Try to get a f64 field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryString() [1/2]

bool Wombat::MamaMsg::tryString ( const char *  name,
mama_fid_t  fid,
const char *&  result 
) const

Try to get a string field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
Returns
Whether the field was present.

§ tryString() [2/2]

bool Wombat::MamaMsg::tryString ( const MamaFieldDescriptor field,
const char *&  result 
) const

Try to get a string field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
Returns
Whether the field was present.

§ tryDateTime() [1/2]

bool Wombat::MamaMsg::tryDateTime ( const char *  name,
mama_fid_t  fid,
MamaDateTime result 
) const

Try to get a date/time field.

Parameters
nameThe field name
fidThe field identifier
resultThe result (not modified if field not present) const
Returns
Whether the field was present.

§ tryDateTime() [2/2]

bool Wombat::MamaMsg::tryDateTime ( const MamaFieldDescriptor field,
MamaDateTime result 
) const

Try to get a date/time field.

Parameters
fieldThe field to try
resultThe result (not modified if field not present) const
Returns
Whether the field was present.

§ tryPrice() [1/2]

bool Wombat::MamaMsg::tryPrice ( const char *  name,
mama_fid_t  fid,
MamaPrice result 
) const

Try to get a price field.

Parameters
nameThe field name
fidThe field identifier
resultThe result (not modified if field not present) const
Returns
Whether the field was present.

§ tryPrice() [2/2]

bool Wombat::MamaMsg::tryPrice ( const MamaFieldDescriptor field,
MamaPrice result 
) const

Try to get a price field.

Parameters
fieldThe field to try
resultThe result (not modified if field not present) const
Returns
Whether the field was present.

§ tryMsg() [1/2]

bool Wombat::MamaMsg::tryMsg ( const char *  name,
mama_fid_t  fid,
const MamaMsg *&  result 
) const

Try to get a submessage field.

Parameters
nameThe field name
fidThe field identifier
resultThe result
Returns
Whether the field was present.

§ tryMsg() [2/2]

bool Wombat::MamaMsg::tryMsg ( const MamaFieldDescriptor field,
const MamaMsg *&  result 
) const

Try to get a submessage field.

Parameters
fieldThe field to try
resultThe result
Returns
Whether the field was present.

§ tryOpaque() [1/2]

bool Wombat::MamaMsg::tryOpaque ( const char *  name,
mama_fid_t  fid,
const void *&  result,
size_t &  size 
) const

Try to get a string field.

Parameters
resultThe result (not modified if field not present) const
nameThe field name
fidThe field identifier
size(out) The size of the opaque in bytes.
Returns
Whether the field was present.

§ tryOpaque() [2/2]

bool Wombat::MamaMsg::tryOpaque ( const MamaFieldDescriptor field,
const void *&  result,
size_t &  size 
) const

Try to get a string field.

Parameters
resultThe result (not modified if field not present) const
fieldThe field to try
size(out) The size of the opaque in bytes.
Returns
Whether the field was present.

§ tryVectorChar() [1/2]

bool Wombat::MamaMsg::tryVectorChar ( const char *  name,
mama_fid_t  fid,
const char *&  result,
size_t &  resultLen 
) const

Try to get a vector of characters.

(Note: prefer using string fields or opaque fields over a vector of characters.)

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorChar() [2/2]

bool Wombat::MamaMsg::tryVectorChar ( const MamaFieldDescriptor fieldDesc,
const char *&  result,
size_t &  resultLen 
) const

Try to get a vector of characters.

(Note: prefer using string fields or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI8() [1/2]

bool Wombat::MamaMsg::tryVectorI8 ( const char *  name,
mama_fid_t  fid,
const mama_i8_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 8-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI8() [2/2]

bool Wombat::MamaMsg::tryVectorI8 ( const MamaFieldDescriptor fieldDesc,
const mama_i8_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 8-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU8() [1/2]

bool Wombat::MamaMsg::tryVectorU8 ( const char *  name,
mama_fid_t  fid,
const mama_u8_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 8-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU8() [2/2]

bool Wombat::MamaMsg::tryVectorU8 ( const MamaFieldDescriptor fieldDesc,
const mama_u8_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 8-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI16() [1/2]

bool Wombat::MamaMsg::tryVectorI16 ( const char *  name,
mama_fid_t  fid,
const mama_i16_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 16-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI16() [2/2]

bool Wombat::MamaMsg::tryVectorI16 ( const MamaFieldDescriptor fieldDesc,
const mama_i16_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 16-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU16() [1/2]

bool Wombat::MamaMsg::tryVectorU16 ( const char *  name,
mama_fid_t  fid,
const mama_u16_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 16-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU16() [2/2]

bool Wombat::MamaMsg::tryVectorU16 ( const MamaFieldDescriptor fieldDesc,
const mama_u16_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 16-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI32() [1/2]

bool Wombat::MamaMsg::tryVectorI32 ( const char *  name,
mama_fid_t  fid,
const mama_i32_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 32-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI32() [2/2]

bool Wombat::MamaMsg::tryVectorI32 ( const MamaFieldDescriptor fieldDesc,
const mama_i32_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 32-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU32() [1/2]

bool Wombat::MamaMsg::tryVectorU32 ( const char *  name,
mama_fid_t  fid,
const mama_u32_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 32-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU32() [2/2]

bool Wombat::MamaMsg::tryVectorU32 ( const MamaFieldDescriptor fieldDesc,
const mama_u32_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 32-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI64() [1/2]

bool Wombat::MamaMsg::tryVectorI64 ( const char *  name,
mama_fid_t  fid,
const mama_i64_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 64-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorI64() [2/2]

bool Wombat::MamaMsg::tryVectorI64 ( const MamaFieldDescriptor fieldDesc,
const mama_i64_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of signed 64-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU64() [1/2]

bool Wombat::MamaMsg::tryVectorU64 ( const char *  name,
mama_fid_t  fid,
const mama_u64_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 64-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorU64() [2/2]

bool Wombat::MamaMsg::tryVectorU64 ( const MamaFieldDescriptor fieldDesc,
const mama_u64_t *&  result,
size_t &  resultLen 
) const

Try to get a vector of unsigned 64-bit integers.

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorF32() [1/2]

bool Wombat::MamaMsg::tryVectorF32 ( const char *  name,
mama_fid_t  fid,
const mama_f32_t *&  result,
size_t &  resultLen 
) const

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

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorF32() [2/2]

bool Wombat::MamaMsg::tryVectorF32 ( const MamaFieldDescriptor fieldDesc,
const mama_f32_t *&  result,
size_t &  resultLen 
) const

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

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorF64() [1/2]

bool Wombat::MamaMsg::tryVectorF64 ( const char *  name,
mama_fid_t  fid,
const mama_f64_t *&  result,
size_t &  resultLen 
) const

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

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorF64() [2/2]

bool Wombat::MamaMsg::tryVectorF64 ( const MamaFieldDescriptor fieldDesc,
const mama_f64_t *&  result,
size_t &  resultLen 
) const

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

or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorString() [1/2]

bool Wombat::MamaMsg::tryVectorString ( const char *  name,
mama_fid_t  fid,
const char **&  result,
size_t &  resultLen 
) const

Try to get a vector of strings.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorString() [2/2]

bool Wombat::MamaMsg::tryVectorString ( const MamaFieldDescriptor fieldDesc,
const char **&  result,
size_t &  resultLen 
) const

Try to get a vector of strings.

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorMsg() [1/2]

bool Wombat::MamaMsg::tryVectorMsg ( const char *  name,
mama_fid_t  fid,
const MamaMsg **&  result,
size_t &  resultLen 
) const

Try to get a vector of submessages field.

Parameters
nameThe field name.
fidThe field identifier.
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ tryVectorMsg() [2/2]

bool Wombat::MamaMsg::tryVectorMsg ( const MamaFieldDescriptor fieldDesc,
const MamaMsg **&  result,
size_t &  resultLen 
) const

Try to get a vector of submessages.

Parameters
fieldDescThe field descriptor
result(out) The vector.
resultLen(out) The size of the vector.
Returns
Whether the field was present.

§ addBoolean() [1/2]

void Wombat::MamaMsg::addBoolean ( const char *  name,
mama_fid_t  fid,
bool  value 
)

Add a new boolean field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addBoolean() [2/2]

void Wombat::MamaMsg::addBoolean ( const MamaFieldDescriptor fieldDesc,
bool  value 
)

Add a new boolean field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addChar() [1/2]

void Wombat::MamaMsg::addChar ( const char *  name,
mama_fid_t  fid,
char  value 
)

Add a new char field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addChar() [2/2]

void Wombat::MamaMsg::addChar ( const MamaFieldDescriptor fieldDesc,
char  value 
)

Add a new char field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addI8() [1/2]

void Wombat::MamaMsg::addI8 ( const char *  name,
mama_fid_t  fid,
mama_i8_t  value 
)

Add a new I8 field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addI8() [2/2]

void Wombat::MamaMsg::addI8 ( const MamaFieldDescriptor fieldDesc,
mama_i8_t  value 
)

Add a new I8 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addI16() [1/2]

void Wombat::MamaMsg::addI16 ( const char *  name,
mama_fid_t  fid,
mama_i16_t  value 
)

Add a new I16 field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addI16() [2/2]

void Wombat::MamaMsg::addI16 ( const MamaFieldDescriptor fieldDesc,
mama_i16_t  value 
)

Add a new I16 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addI32() [1/2]

void Wombat::MamaMsg::addI32 ( const char *  name,
mama_fid_t  fid,
mama_i32_t  value 
)

Add a new I32 field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addI32() [2/2]

void Wombat::MamaMsg::addI32 ( const MamaFieldDescriptor fieldDesc,
mama_i32_t  value 
)

Add a new I32 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addI64() [1/2]

void Wombat::MamaMsg::addI64 ( const char *  name,
mama_fid_t  fid,
mama_i64_t  value 
)

Add a new I64 field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addI64() [2/2]

void Wombat::MamaMsg::addI64 ( const MamaFieldDescriptor fieldDesc,
mama_i64_t  value 
)

Add a new I64 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addU8() [1/2]

void Wombat::MamaMsg::addU8 ( const char *  name,
mama_fid_t  fid,
mama_u8_t  value 
)

Add a new byte (U8) const field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addU8() [2/2]

void Wombat::MamaMsg::addU8 ( const MamaFieldDescriptor fieldDesc,
mama_u8_t  value 
)

Add a new U8 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addU16() [1/2]

void Wombat::MamaMsg::addU16 ( const char *  name,
mama_fid_t  fid,
mama_u16_t  value 
)

Add a new short (U16) const field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addU16() [2/2]

void Wombat::MamaMsg::addU16 ( const MamaFieldDescriptor fieldDesc,
mama_u16_t  value 
)

Add a new U16 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addU32() [1/2]

void Wombat::MamaMsg::addU32 ( const char *  name,
mama_fid_t  fid,
mama_u32_t  value 
)

Add a new int (U32) const field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addU32() [2/2]

void Wombat::MamaMsg::addU32 ( const MamaFieldDescriptor fieldDesc,
mama_u32_t  value 
)

Add a new U32 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addU64() [1/2]

void Wombat::MamaMsg::addU64 ( const char *  name,
mama_fid_t  fid,
mama_u64_t  value 
)

Add a new int (U64) const field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addU64() [2/2]

void Wombat::MamaMsg::addU64 ( const MamaFieldDescriptor fieldDesc,
mama_u64_t  value 
)

Add a new U64 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addF32() [1/2]

void Wombat::MamaMsg::addF32 ( const char *  name,
mama_fid_t  fid,
mama_f32_t  value 
)

Add a new F32 field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addF32() [2/2]

void Wombat::MamaMsg::addF32 ( const MamaFieldDescriptor fieldDesc,
mama_f32_t  value 
)

Add a new F32 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addF64() [1/2]

void Wombat::MamaMsg::addF64 ( const char *  name,
mama_fid_t  fid,
mama_f64_t  value 
)

Add a new F64 field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addF64() [2/2]

void Wombat::MamaMsg::addF64 ( const MamaFieldDescriptor fieldDesc,
mama_f64_t  value 
)

Add a new F64 field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addString() [1/2]

void Wombat::MamaMsg::addString ( const char *  name,
mama_fid_t  fid,
const char *  value 
)

Add a const char* field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.

§ addString() [2/2]

void Wombat::MamaMsg::addString ( const MamaFieldDescriptor fieldDesc,
const char *  value 
)

Add a new const char* field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addDateTime() [1/2]

void Wombat::MamaMsg::addDateTime ( const char *  name,
mama_fid_t  fid,
const MamaDateTime value 
)

Add a date/time field.

Parameters
nameThe field name.
fidThe field identifier.
valueThe value.

§ addDateTime() [2/2]

void Wombat::MamaMsg::addDateTime ( const MamaFieldDescriptor fieldDesc,
const MamaDateTime value 
)

Add a new date/time field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addPrice() [1/2]

void Wombat::MamaMsg::addPrice ( const char *  name,
mama_fid_t  fid,
const MamaPrice value 
)

Add a price field.

Parameters
nameThe field name.
fidThe field identifier.
valueThe value.

§ addPrice() [2/2]

void Wombat::MamaMsg::addPrice ( const MamaFieldDescriptor fieldDesc,
const MamaPrice value 
)

Add a new price field.

Parameters
fieldDescThe field descriptor
valueThe value.

§ addOpaque() [1/2]

void Wombat::MamaMsg::addOpaque ( const char *  name,
mama_fid_t  fid,
const void *  value,
size_t  size 
)

Add an opaque field.

Parameters
nameThe name.
valueThe value.
fidThe field identifier.
sizethe size of the opaque field, in bytes

§ addOpaque() [2/2]

void Wombat::MamaMsg::addOpaque ( const MamaFieldDescriptor fieldDesc,
const void *  value,
size_t  size 
)

Add an opaque field.

Parameters
fieldDescThe field descriptor
valueThe value.
sizethe size of the opaque field, in bytes

§ addMsg() [1/2]

void Wombat::MamaMsg::addMsg ( const char *  name,
mama_fid_t  fid,
MamaMsg value 
)

Add a MamaMsg object.

Parameters
nameThe field name.
fidThe field identifier.
valuethe value to add

§ addMsg() [2/2]

void Wombat::MamaMsg::addMsg ( const MamaFieldDescriptor fieldDesc,
MamaMsg value 
)

Add a MamaMsg object.

Parameters
fieldDescThe field descriptor
valuethe value to add

§ addVectorChar() [1/2]

void Wombat::MamaMsg::addVectorChar ( const char *  name,
mama_fid_t  fid,
const char  vectorValues[],
size_t  vectorLen 
)

Add a vector of characters.

(Note: prefer using string fields or opaque fields over a vector of characters.)

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorChar() [2/2]

void Wombat::MamaMsg::addVectorChar ( const MamaFieldDescriptor fieldDesc,
const char  vectorValues[],
size_t  vectorLen 
)

Add a vector of characters.

(Note: prefer using string fields or opaque fields over a vector of characters.)

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI8() [1/2]

void Wombat::MamaMsg::addVectorI8 ( const char *  name,
mama_fid_t  fid,
const mama_i8_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 8-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI8() [2/2]

void Wombat::MamaMsg::addVectorI8 ( const MamaFieldDescriptor fieldDesc,
const mama_i8_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 8-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU8() [1/2]

void Wombat::MamaMsg::addVectorU8 ( const char *  name,
mama_fid_t  fid,
const mama_u8_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 8-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU8() [2/2]

void Wombat::MamaMsg::addVectorU8 ( const MamaFieldDescriptor fieldDesc,
const mama_u8_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 8-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI16() [1/2]

void Wombat::MamaMsg::addVectorI16 ( const char *  name,
mama_fid_t  fid,
const mama_i16_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 16-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI16() [2/2]

void Wombat::MamaMsg::addVectorI16 ( const MamaFieldDescriptor fieldDesc,
const mama_i16_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 16-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU16() [1/2]

void Wombat::MamaMsg::addVectorU16 ( const char *  name,
mama_fid_t  fid,
const mama_u16_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 16-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU16() [2/2]

void Wombat::MamaMsg::addVectorU16 ( const MamaFieldDescriptor fieldDesc,
const mama_u16_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 16-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI32() [1/2]

void Wombat::MamaMsg::addVectorI32 ( const char *  name,
mama_fid_t  fid,
const mama_i32_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 32-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI32() [2/2]

void Wombat::MamaMsg::addVectorI32 ( const MamaFieldDescriptor fieldDesc,
const mama_i32_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 32-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU32() [1/2]

void Wombat::MamaMsg::addVectorU32 ( const char *  name,
mama_fid_t  fid,
const mama_u32_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 32-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU32() [2/2]

void Wombat::MamaMsg::addVectorU32 ( const MamaFieldDescriptor fieldDesc,
const mama_u32_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 32-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI64() [1/2]

void Wombat::MamaMsg::addVectorI64 ( const char *  name,
mama_fid_t  fid,
const mama_i64_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 64-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorI64() [2/2]

void Wombat::MamaMsg::addVectorI64 ( const MamaFieldDescriptor fieldDesc,
const mama_i64_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of signed 64-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU64() [1/2]

void Wombat::MamaMsg::addVectorU64 ( const char *  name,
mama_fid_t  fid,
const mama_u64_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 64-bit integers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorU64() [2/2]

void Wombat::MamaMsg::addVectorU64 ( const MamaFieldDescriptor fieldDesc,
const mama_u64_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 64-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorF32() [1/2]

void Wombat::MamaMsg::addVectorF32 ( const char *  name,
mama_fid_t  fid,
const mama_f32_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of 32-bit floating point numbers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorF32() [2/2]

void Wombat::MamaMsg::addVectorF32 ( const MamaFieldDescriptor fieldDesc,
const mama_f32_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 32-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorF64() [1/2]

void Wombat::MamaMsg::addVectorF64 ( const char *  name,
mama_fid_t  fid,
const mama_f64_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of 64-bit floating point numbers.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorF64() [2/2]

void Wombat::MamaMsg::addVectorF64 ( const MamaFieldDescriptor fieldDesc,
const mama_f64_t  vectorValues[],
size_t  vectorLen 
)

Add a vector of unsigned 64-bit integers.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorString() [1/2]

void Wombat::MamaMsg::addVectorString ( const char *  name,
mama_fid_t  fid,
const char *  vectorValues[],
size_t  vectorLen 
)

Add a vector of strings.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorString() [2/2]

void Wombat::MamaMsg::addVectorString ( const MamaFieldDescriptor fieldDesc,
const char *  vectorValues[],
size_t  vectorLen 
)

Add a vector of strings.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorMsg() [1/2]

void Wombat::MamaMsg::addVectorMsg ( const char *  name,
mama_fid_t  fid,
MamaMsg vectorValues[],
size_t  vectorLen 
)

Add a vector of MamaMsg objects.

Parameters
nameThe field name.
fidThe field identifier.
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ addVectorMsg() [2/2]

void Wombat::MamaMsg::addVectorMsg ( const MamaFieldDescriptor fieldDesc,
MamaMsg vectorValues[],
size_t  vectorLen 
)

Add a vector of MamaMsg objects.

Parameters
fieldDescThe field descriptor
vectorValuesThe vector values.
vectorLenThe size of the vector.

§ updateBoolean() [1/2]

void Wombat::MamaMsg::updateBoolean ( const char *  name,
mama_fid_t  fid,
bool  value 
)

Update the value of an existing boolean field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateBoolean() [2/2]

void Wombat::MamaMsg::updateBoolean ( const MamaFieldDescriptor fieldDesc,
bool  value 
)

Update the value of an existing boolean field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateChar() [1/2]

void Wombat::MamaMsg::updateChar ( const char *  name,
mama_fid_t  fid,
const char  value 
)

Update the value of an existing char field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateChar() [2/2]

void Wombat::MamaMsg::updateChar ( const MamaFieldDescriptor fieldDesc,
const char  value 
)

Update the value of an existing char field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateI8() [1/2]

void Wombat::MamaMsg::updateI8 ( const char *  name,
mama_fid_t  fid,
const mama_i8_t  value 
)

Update the value of an existing byte field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateI8() [2/2]

void Wombat::MamaMsg::updateI8 ( const MamaFieldDescriptor fieldDesc,
const mama_i8_t  value 
)

Update the value of an existing byte field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateU8() [1/2]

void Wombat::MamaMsg::updateU8 ( const char *  name,
mama_fid_t  fid,
const mama_u8_t  value 
)

Update the value of an existing U8 field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateU8() [2/2]

void Wombat::MamaMsg::updateU8 ( const MamaFieldDescriptor fieldDesc,
const mama_u8_t  value 
)

Update the value of an existing U8 field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateI16() [1/2]

void Wombat::MamaMsg::updateI16 ( const char *  name,
mama_fid_t  fid,
const mama_i16_t  value 
)

Update the value of an existing short field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateI16() [2/2]

void Wombat::MamaMsg::updateI16 ( const MamaFieldDescriptor fieldDesc,
const mama_i16_t  value 
)

Update the value of an existing short field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateU16() [1/2]

void Wombat::MamaMsg::updateU16 ( const char *  name,
mama_fid_t  fid,
const mama_u16_t  value 
)

Update the value of an existing U16 field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateU16() [2/2]

void Wombat::MamaMsg::updateU16 ( const MamaFieldDescriptor fieldDesc,
const mama_u16_t  value 
)

Update the value of an existing U16 field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateI32() [1/2]

void Wombat::MamaMsg::updateI32 ( const char *  name,
mama_fid_t  fid,
const mama_i32_t  value 
)

Update the value of an existing integer field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateI32() [2/2]

void Wombat::MamaMsg::updateI32 ( const MamaFieldDescriptor fieldDesc,
const mama_i32_t  value 
)

Update the value of an existing integer field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateU32() [1/2]

void Wombat::MamaMsg::updateU32 ( const char *  name,
mama_fid_t  fid,
const mama_u32_t  value 
)

Update the value of an existing U32 field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateU32() [2/2]

void Wombat::MamaMsg::updateU32 ( const MamaFieldDescriptor fieldDesc,
const mama_u32_t  value 
)

Update the value of an existing U32 field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateI64() [1/2]

void Wombat::MamaMsg::updateI64 ( const char *  name,
mama_fid_t  fid,
const mama_i64_t  value 
)

Update the value of an existing long field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateI64() [2/2]

void Wombat::MamaMsg::updateI64 ( const MamaFieldDescriptor fieldDesc,
const mama_i64_t  value 
)

Update the value of an existing long field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateU64() [1/2]

void Wombat::MamaMsg::updateU64 ( const char *  name,
mama_fid_t  fid,
const mama_u64_t  value 
)

Update the value of an existing U64 field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateU64() [2/2]

void Wombat::MamaMsg::updateU64 ( const MamaFieldDescriptor fieldDesc,
const mama_u64_t  value 
)

Update the value of an existing U64 field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateF32() [1/2]

void Wombat::MamaMsg::updateF32 ( const char *  name,
mama_fid_t  fid,
const mama_f32_t  value 
)

Update the value of an existing F32 field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateF32() [2/2]

void Wombat::MamaMsg::updateF32 ( const MamaFieldDescriptor fieldDesc,
const mama_f32_t  value 
)

Update the value of an existing F32 field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateF64() [1/2]

void Wombat::MamaMsg::updateF64 ( const char *  name,
mama_fid_t  fid,
const mama_f64_t  value 
)

Update the value of an existing F64 field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateF64() [2/2]

void Wombat::MamaMsg::updateF64 ( const MamaFieldDescriptor fieldDesc,
const mama_f64_t  value 
)

Update the value of an existing F64 field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateString() [1/2]

void Wombat::MamaMsg::updateString ( const char *  name,
mama_fid_t  fid,
const char *  value 
)

Update the value of an existing const char* field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.

§ updateString() [2/2]

void Wombat::MamaMsg::updateString ( const MamaFieldDescriptor fieldDesc,
const char *  value 
)

Update the value of an existing string field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updateOpaque() [1/2]

void Wombat::MamaMsg::updateOpaque ( const char *  name,
mama_fid_t  fid,
const void *  value,
size_t  size 
)

Update the value of an existing opaque field.

If the field does not exist it is added.

Parameters
nameThe name.
valueThe new value.
fidThe field identifier.
sizeThe size of the opaque in bytes

§ updateOpaque() [2/2]

void Wombat::MamaMsg::updateOpaque ( const MamaFieldDescriptor fieldDesc,
const void *  value,
size_t  size 
)

Update the value of an existing opaque field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.
sizeThe size of the opaque in bytes

§ updateDateTime() [1/2]

void Wombat::MamaMsg::updateDateTime ( const char *  name,
mama_fid_t  fid,
const MamaDateTime value 
)

Update a date/time field.

If the field does not exist it is added.

Parameters
nameThe field name.
fidThe field identifier.
valueThe value.

§ updateDateTime() [2/2]

void Wombat::MamaMsg::updateDateTime ( const MamaFieldDescriptor fieldDesc,
const MamaDateTime value 
)

Update the value of an existing date/time field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ updatePrice() [1/2]

void Wombat::MamaMsg::updatePrice ( const char *  name,
mama_fid_t  fid,
const MamaPrice value 
)

Update a price field.

If the field does not exist it is added.

Parameters
nameThe field name.
fidThe field identifier.
valueThe value.

§ updatePrice() [2/2]

void Wombat::MamaMsg::updatePrice ( const MamaFieldDescriptor fieldDesc,
const MamaPrice value 
)

Update the value of an existing price field.

If the field does not exist it is added.

Parameters
fieldDescThe field descriptor
valueThe new value.

§ getType()

mamaMsgType Wombat::MamaMsg::getType ( void  ) const

Get the message type.

§ getMsgTypeName()

const char* Wombat::MamaMsg::getMsgTypeName ( void  ) const

Get a human readable type name.

§ getStatus()

mamaMsgStatus Wombat::MamaMsg::getStatus ( void  ) const

Get the msg status.

§ getMsgStatusString()

const char* Wombat::MamaMsg::getMsgStatusString ( void  ) const

Get human readable message status.

§ iterateFields()

void Wombat::MamaMsg::iterateFields ( MamaMsgFieldIterator iterator,
const MamaDictionary dictionary,
void *  closure 
) const

Iterate over all the fields.

§ toString()

const char* Wombat::MamaMsg::toString ( ) const

Return a const char * representation the message.

The memory allocated by this method gets freed upon destroying the message or invoking toString() again.

Returns
A string representation of the message.

§ getFieldAsString() [1/2]

void Wombat::MamaMsg::getFieldAsString ( const char *  name,
mama_fid_t  fid,
char *  result,
size_t  maxResultLen 
) const

Obtain a string representation the field with the given fid.

Parameters
nameThe field name.
fidThe field identifier.
resultBuffer to put result.
maxResultLenMaximum size of buffer to put result.

§ getFieldAsString() [2/2]

void Wombat::MamaMsg::getFieldAsString ( const MamaFieldDescriptor fieldDesc,
char *  result,
size_t  maxResultLen 
) const

Obtain a string representation the field with the given fid.

Parameters
fieldDescThe field descriptor
resultBuffer to put result.
maxResultLenMaximum size of buffer to put result.

§ getField() [1/2]

MamaMsgField* Wombat::MamaMsg::getField ( const char *  name,
mama_fid_t  fid 
) const

Obtain a the mamaMsgField with the given fid.

Parameters
nameThe field name.
fidThe field identifier.

§ getField() [2/2]

MamaMsgField* Wombat::MamaMsg::getField ( const MamaFieldDescriptor fieldDesc) const

Obtain a the mamaMsgField with the given fid.

Parameters
fieldDescThe field descriptor

§ tryField() [1/4]

bool Wombat::MamaMsg::tryField ( const char *  name,
mama_fid_t  fid 
) const

Test for the presence of the MamaMsgField with the given fid.

This method does not return the field.

Parameters
nameThe field name.
fidThe field identifier.

§ tryField() [2/4]

bool Wombat::MamaMsg::tryField ( const MamaFieldDescriptor fieldDesc) const

Test for the presence of the MamaMsgField with the given field descriptor.

This method does not return the field.

Parameters
fieldDescThe field descriptor

§ tryField() [3/4]

bool Wombat::MamaMsg::tryField ( const char *  name,
mama_fid_t  fid,
MamaMsgField result 
) const

Try to obtain the MamaMsgField with the given fid.

Parameters
nameThe field name.
fidThe field identifier.
resultThe result (not modified if field not present)

§ tryField() [4/4]

bool Wombat::MamaMsg::tryField ( const MamaFieldDescriptor fieldDesc,
MamaMsgField result 
) const

Try to obtain the MamaMsgField with the given field descriptor.

Parameters
fieldDescThe field descriptor
resultThe result (not modified if field not present)

§ tryFieldAsString() [1/2]

bool Wombat::MamaMsg::tryFieldAsString ( const char *  name,
mama_fid_t  fid,
char *  result,
size_t  maxResultLen 
) const

Try to obtain a string representation the field with the given fid.

Parameters
nameThe field name.
fidThe field identifier.
resultBuffer to put result.
maxResultLenMaximum size of buffer to put result.
Returns
Whether the field was present.

§ tryFieldAsString() [2/2]

bool Wombat::MamaMsg::tryFieldAsString ( const MamaFieldDescriptor fieldDesc,
char *  result,
size_t  maxResultLen 
) const

Try to obtain a string representation the field with the given fid.

Parameters
fieldDescThe field descriptor
resultBuffer to put result.
maxResultLenMaximum size of buffer to put result.
Returns
Whether the field was present.

§ getByteBuffer()

void Wombat::MamaMsg::getByteBuffer ( const void *&  buffer,
size_t &  bufferLength 
) const

Get the underlying message as an array of bytes.

The buffer still belongs to the underlying message so no attempt should be made to modify it.

Parameters
bufferThe byte array containing the buffer
bufferLengthThe length, in bytes of the returned buffer

§ detach()

MamaMsg* Wombat::MamaMsg::detach ( void  )

Normally the Mama API owns incoming mamaMsg objects and they go out of scope and are freed when the message callback returns.

Calling this method from the message callback creates a new C++ wrapper for the underlying message and transfers responsibility for calling destroy() to the caller.

The caller must also delete the pointer returned by detach(). Note that calling "delete msg.detach()" invokes destroy() so calling destroy is not necessary if the application calls delete.

§ isFromInbox()

bool Wombat::MamaMsg::isFromInbox ( void  ) const

Whether this message is the result of a request needing a response.

§ getSeqNum()

mama_seqnum_t Wombat::MamaMsg::getSeqNum ( void  ) const

§ getIsDefinitelyDuplicate()

bool Wombat::MamaMsg::getIsDefinitelyDuplicate ( void  ) const

Return true if this message is definitely a duplicate message.

This condition will not occur with the current feed handlers.

§ getIsPossiblyDuplicate()

bool Wombat::MamaMsg::getIsPossiblyDuplicate ( void  ) const

Return true if this message is possibly a duplicate message.

This may occur in the event of a fault tolerant feed handler take over where the feed handler replays messages to prevent gaps.

§ getIsPossiblyDelayed()

bool Wombat::MamaMsg::getIsPossiblyDelayed ( void  ) const

Return true if the message is possibly delayed.

This condition may be true during a fault-tolerant takeover.

§ getIsDefinitelyDelayed()

bool Wombat::MamaMsg::getIsDefinitelyDelayed ( void  ) const

Return true if the message is delayed.

This condition may be true during a fault-tolerant takeover.

§ getIsOutOfSequence()

bool Wombat::MamaMsg::getIsOutOfSequence ( void  ) const

Return true when the FH sends the message out of sequence.

§ setNewBuffer()

bool Wombat::MamaMsg::setNewBuffer ( void *  buffer,
mama_size_t  size 
)

Sets a new for an existing mamaMsg using the provided byte buffer.

The application is responsible for destroying the message.

Parameters
bufferthe new byte buffer
sizesize of buffer
Returns
status

§ getNativeHandle()

void* Wombat::MamaMsg::getNativeHandle ( void  ) const

Return the native middleware message handle.

This is only intended for Wombat internal use.

§ createFromMsg()

void Wombat::MamaMsg::createFromMsg ( mamaMsg  msg,
bool  destroyMsg = false 
) const

Create the message from an existing mamaMsg.

§ setMsg()

void Wombat::MamaMsg::setMsg ( mamaMsg  msg)

Set the message to a different underlying C message.

Can be called multiple times on a single MamaMsg

§ getUnderlyingMsg() [1/2]

const mamaMsg& Wombat::MamaMsg::getUnderlyingMsg ( void  ) const

Return const reference to underlying mamaMsg.

§ getUnderlyingMsg() [2/2]

mamaMsg Wombat::MamaMsg::getUnderlyingMsg ( void  )

Return the underlying mamaMsg (non const)

§ getPayloadType()

MAMAIgnoreDeprecatedOpen mamaPayloadType Wombat::MamaMsg::getPayloadType ( void  ) const

Return the type of the payload message (wombat message or, if using a non-wombat message payload, RV or FAST message).

Returns
payloadType The payload type.

§ getNativeMsg()

MAMAIgnoreDeprecatedClose void* Wombat::MamaMsg::getNativeMsg ( void  )

Get the native message structure for the underlying message.

Returns
nativeMsg The resulting native handle.

§ begin()

MamaMsgField& Wombat::MamaMsg::begin ( MamaMsgIterator theIterator) const

Sets a iterator to be used with existing mamaMsg.

The iterator is set to the first MamaMsgField of the mamaMsg

Parameters
theiteratoriterator to be used
Returns
first MamaMsgField

§ getReplyHandle()

mamaMsgReply Wombat::MamaMsg::getReplyHandle ( void  ) const

Get a copy of the reply Handle.

§ destroyReplyHandle()

static void Wombat::MamaMsg::destroyReplyHandle ( mamaMsgReply  replyHandle)
static

Destroy a copied reply Handle.