OpenMAMA
msg.h File Reference
#include <mama/types.h>
#include <mama/status.h>
#include <mama/fielddesc.h>
#include <mama/msgtype.h>
#include "wombat/port.h"
#include <stdlib.h>

Go to the source code of this file.

Macros

#define ENTITLE_FIELD_NAME   "wEntitleCode"
 
#define ENTITLE_FIELD_ID   496
 

Typedefs

typedef enum mamaPayloadType_ mamaPayloadType
 Enum to reference the available MAMA message payloads. More...
 
typedef void(MAMACALLTYPE * mamaMsgIteratorCb) (const mamaMsg msg, const mamaMsgField field, void *closure)
 Iterator callback method is invoked for each field in the message. More...
 

Enumerations

enum  mamaPayloadType_ {
  MAMA_PAYLOAD_WOMBAT_MSG = 'W', MAMA_PAYLOAD_TIBRV = 'R', MAMA_PAYLOAD_FAST = 'F', MAMA_PAYLOAD_V5 = '5',
  MAMA_PAYLOAD_AVIS = 'A', MAMA_PAYLOAD_TICK42BLP = 'B', MAMA_PAYLOAD_RAI = 'I', MAMA_PAYLOAD_EXEGY = 'X',
  MAMA_PAYLOAD_UNKNOWN = 'U'
}
 Enum to reference the available MAMA message payloads. More...
 

Functions

MAMAExpDLL const char * mamaPayload_convertToString (mamaPayloadType payloadType)
 Convert a mamaPayloadType value to a string. More...
 
MAMAExpDLL mama_status mamaMsg_create (mamaMsg *msg)
 Create a mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsg_createForPayload (mamaMsg *msg, const char id)
 Create a mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsg_createForPayloadBridge (mamaMsg *msg, mamaPayloadBridge payloadBridge)
 Create a mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsg_createForTemplate (mamaMsg *msg, mama_u32_t templateId)
 Create a mamaMsg for a particular template ID. More...
 
MAMAExpDLL mama_status mamaMsg_copy (mamaMsg src, mamaMsg *copy)
 Copy a mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsg_getTempCopy (mamaMsg src, mamaMsg *copy)
 Get a temporary copy of the mamaMsg so to be able to modify the content. More...
 
MAMAExpDLL mama_status mamaMsg_clear (mamaMsg msg)
 Clear a msg. More...
 
MAMAExpDLL mama_status mamaMsg_getSendSubject (const mamaMsg msg, const char **subject)
 TIB/RV only. More...
 
MAMAExpDLL mama_status mamaMsg_destroy (mamaMsg msg)
 Destroy a message and free any resources associated with it. More...
 
MAMAExpDLL mama_status mamaMsg_getPayloadType (mamaMsg msg, mamaPayloadType *payloadType)
 Get the type of the message payload. More...
 
MAMAExpDLL mama_status mamaMsg_getByteSize (const mamaMsg msg, mama_size_t *size)
 Get the size of the underlying message in bytes. More...
 
MAMAExpDLL mama_status mamaMsg_addBool (mamaMsg msg, const char *name, mama_fid_t fid, mama_bool_t value)
 Add a new bool field. More...
 
MAMAExpDLL mama_status mamaMsg_addChar (mamaMsg msg, const char *name, mama_fid_t fid, char value)
 Add a new char field. More...
 
MAMAExpDLL mama_status mamaMsg_addI8 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i8_t value)
 Add a new 8 bit signed int field. More...
 
MAMAExpDLL mama_status mamaMsg_addU8 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u8_t value)
 Add a new 8 bit unsigned int field. More...
 
MAMAExpDLL mama_status mamaMsg_addI16 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i16_t value)
 Add a new 16 bit signed int field. More...
 
MAMAExpDLL mama_status mamaMsg_addU16 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u16_t value)
 Add a new 16 bit unsigned int field. More...
 
MAMAExpDLL mama_status mamaMsg_addI32 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i32_t value)
 Add a new 32 bit unsigned int field. More...
 
MAMAExpDLL mama_status mamaMsg_addU32 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u32_t value)
 Add a new 32 bit signed int field. More...
 
MAMAExpDLL mama_status mamaMsg_addI64 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i64_t value)
 Add a new I64 field. More...
 
MAMAExpDLL mama_status mamaMsg_addU64 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u64_t value)
 Add a new U64 field. More...
 
MAMAExpDLL mama_status mamaMsg_addF32 (mamaMsg msg, const char *name, mama_fid_t fid, mama_f32_t value)
 Add a new float (f32) field. More...
 
MAMAExpDLL mama_status mamaMsg_addF64 (mamaMsg msg, const char *name, mama_fid_t fid, mama_f64_t value)
 Add a new f64 field. More...
 
MAMAExpDLL mama_status mamaMsg_addString (mamaMsg msg, const char *name, mama_fid_t fid, const char *value)
 Add a const char * field. More...
 
MAMAExpDLL mama_status mamaMsg_addOpaque (mamaMsg msg, const char *name, mama_fid_t fid, const void *value, mama_size_t size)
 Add an opaque field. More...
 
MAMAExpDLL mama_status mamaMsg_addDateTime (mamaMsg msg, const char *name, mama_fid_t fid, const mamaDateTime value)
 Add a MAMA date/time field. More...
 
MAMAExpDLL mama_status mamaMsg_addPrice (mamaMsg msg, const char *name, mama_fid_t fid, const mamaPrice value)
 Add a MAMA price field. More...
 
MAMAExpDLL mama_status mamaMsg_addMsg (mamaMsg msg, const char *name, mama_fid_t fid, const mamaMsg value)
 Add a mamaMsg object to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorBool (mamaMsg msg, const char *name, mama_fid_t fid, const mama_bool_t value[], mama_size_t numElements)
 Add an array of booleans to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorChar (mamaMsg msg, const char *name, mama_fid_t fid, const char value[], mama_size_t numElements)
 Add an array of characters to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorI8 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_i8_t value[], mama_size_t numElements)
 Add an array of signed 8 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorU8 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_u8_t value[], mama_size_t numElements)
 Add an array of unsigned 8 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorI16 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_i16_t value[], mama_size_t numElements)
 Add an array of signed 16 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorU16 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_u16_t value[], mama_size_t numElements)
 Add an array of unsigned 16 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorI32 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_i32_t value[], mama_size_t numElements)
 Add an array of signed 32 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorU32 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_u32_t value[], mama_size_t numElements)
 Add an array of unsigned 32 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorI64 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_i64_t value[], mama_size_t numElements)
 Add an array of signed 64 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorU64 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_u64_t value[], mama_size_t numElements)
 Add an array of unsigned 64 bit integers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorF32 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_f32_t value[], mama_size_t numElements)
 Add an array of 32 bit floating point numbers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorF64 (mamaMsg msg, const char *name, mama_fid_t fid, const mama_f64_t value[], mama_size_t numElements)
 Add an array of 64 bit floating point numbers to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorString (mamaMsg msg, const char *name, mama_fid_t fid, const char *value[], mama_size_t numElements)
 Add an array of strings (char*) to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorMsg (mamaMsg msg, const char *name, mama_fid_t fid, const mamaMsg value[], mama_size_t numElements)
 Add an array of mamaMsg objects to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorDateTime (mamaMsg msg, const char *name, mama_fid_t fid, const mamaDateTime value[], mama_size_t numElements)
 Add an array of timestamps to the message. More...
 
MAMAExpDLL mama_status mamaMsg_addVectorPrice (mamaMsg msg, const char *name, mama_fid_t fid, const mamaPrice value[], mama_size_t numElements)
 Add an array of prices to the message. More...
 
MAMAExpDLL mama_status mamaMsg_updateBool (mamaMsg msg, const char *name, mama_fid_t fid, mama_bool_t value)
 Update the value of an existing bool field. More...
 
MAMAExpDLL mama_status mamaMsg_updateChar (mamaMsg msg, const char *name, mama_fid_t fid, char value)
 Update the value of an existing char field. More...
 
MAMAExpDLL mama_status mamaMsg_updateI8 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i8_t value)
 Update the value of an existing I8 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateU8 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u8_t value)
 Update the value of an existing U8 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateI16 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i16_t value)
 Update the value of an existing I16 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateU16 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u16_t value)
 Update the value of an existing U16 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateI32 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i32_t value)
 Update the value of an existing I32 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateU32 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u32_t value)
 Update the value of an existing U32 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateI64 (mamaMsg msg, const char *name, mama_fid_t fid, mama_i64_t value)
 Update the value of an existing I64 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateU64 (mamaMsg msg, const char *name, mama_fid_t fid, mama_u64_t value)
 Update the value of an existing U64 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateF32 (mamaMsg msg, const char *name, mama_fid_t fid, mama_f32_t value)
 Update the value of an existing float field. More...
 
MAMAExpDLL mama_status mamaMsg_updateF64 (mamaMsg msg, const char *name, mama_fid_t fid, mama_f64_t value)
 Update the value of an existing f64 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateString (mamaMsg msg, const char *name, mama_fid_t fid, const char *value)
 Update the value of an existing const char* field. More...
 
MAMAExpDLL mama_status mamaMsg_updateOpaque (mamaMsg msg, const char *name, mama_fid_t fid, const void *value, mama_size_t size)
 Update an opaque field. More...
 
MAMAExpDLL mama_status mamaMsg_updateDateTime (mamaMsg msg, const char *name, mama_fid_t fid, const mamaDateTime value)
 Update a MAMA date/time field. More...
 
MAMAExpDLL mama_status mamaMsg_updatePrice (mamaMsg msg, const char *name, mama_fid_t fid, const mamaPrice value)
 Update a MAMA price field. More...
 
MAMAExpDLL mama_status mamaMsg_getBool (const mamaMsg msg, const char *name, mama_fid_t fid, mama_bool_t *result)
 Get a bool field. More...
 
MAMAExpDLL mama_status mamaMsg_applyMsg (mamaMsg dest, mamaMsg src)
 Apply the contents of one message to another as updates. More...
 
MAMAExpDLL mama_status mamaMsg_getNativeMsg (mamaMsg msg, void **nativeMsg)
 Get the native message structure for the underlying message This function is for internal NYSE Technologies use only. More...
 
MAMAExpDLL mama_status mamaMsg_getReplyHandle (mamaMsg msg, mamaMsgReply *replyHandle)
 Get the reply handle for the message and increments the reference count for the handle. More...
 
MAMAExpDLL mama_status mamaMsg_setReplyHandle (mamaMsg msg, mamaMsgReply replyHandle)
 Set the reply handle for the message and increments the reference count for the handle. More...
 
MAMAExpDLL mama_status mamaMsg_copyReplyHandle (mamaMsgReply src, mamaMsgReply *copy)
 Create a new copy of the src reply handle. More...
 
MAMAExpDLL mama_status mamaMsg_destroyReplyHandle (mamaMsgReply replyHandle)
 Destroys a reply handle. More...
 
MAMAExpDLL mama_status mamaMsg_updateSubMsg (mamaMsg msg, const char *fname, mama_fid_t fid, const mamaMsg subMsg)
 Update a sub-message field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorMsg (mamaMsg msg, const char *fname, mama_fid_t fid, const mamaMsg msgList[], mama_size_t numElements)
 Update a vector message field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorString (mamaMsg msg, const char *fname, mama_fid_t fid, const char *strList[], mama_size_t numElements)
 Update a vector string field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorBool (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_bool_t boolList[], mama_size_t numElements)
 Update a vector bool field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorChar (mamaMsg msg, const char *fname, mama_fid_t fid, const char charList[], mama_size_t numElements)
 Update a vector char field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorI8 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_i8_t i8List[], mama_size_t numElements)
 Update a vector I8 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorU8 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_u8_t u8List[], mama_size_t numElements)
 Update a vector U8 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorI16 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_i16_t i16List[], mama_size_t numElements)
 Update a vector I16 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorU16 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_u16_t u16List[], mama_size_t numElements)
 Update a vector U16 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorI32 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_i32_t i32List[], mama_size_t numElements)
 Update a vector I32 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorU32 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_u32_t u32List[], mama_size_t numElements)
 Update a vector U32 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorI64 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_i64_t i64List[], mama_size_t numElements)
 Update a vector I64 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorU64 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_u64_t u64List[], mama_size_t numElements)
 Update a vector U64 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorF32 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_f32_t f32List[], mama_size_t numElements)
 Update a vector F32 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorF64 (mamaMsg msg, const char *fname, mama_fid_t fid, const mama_f64_t f64List[], mama_size_t numElements)
 Update a vector F64 field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorPrice (mamaMsg msg, const char *fname, mama_fid_t fid, const mamaPrice *priceList[], mama_size_t numElements)
 Update a vector price field. More...
 
MAMAExpDLL mama_status mamaMsg_updateVectorTime (mamaMsg msg, const char *fname, mama_fid_t fid, const mamaDateTime timeList[], mama_size_t numElements)
 Update a vector mamaDateTime field. More...
 
MAMAExpDLL mama_status mamaMsg_getChar (const mamaMsg msg, const char *name, mama_fid_t fid, char *result)
 Get a char field. More...
 
MAMAExpDLL mama_status mamaMsg_getI8 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_i8_t *result)
 Get a I8, signed 8 bit integer, field. More...
 
MAMAExpDLL mama_status mamaMsg_getU8 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_u8_t *result)
 Get an unsigned 8-bit integer field. More...
 
MAMAExpDLL mama_status mamaMsg_getI16 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_i16_t *result)
 Get a I16, signed 16 bit integer, field. More...
 
MAMAExpDLL mama_status mamaMsg_getU16 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_u16_t *result)
 Get an unsigned 16-bit integer field. More...
 
MAMAExpDLL mama_status mamaMsg_getI32 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_i32_t *result)
 Get a I32, signed 32 bit integer, field. More...
 
MAMAExpDLL mama_status mamaMsg_getU32 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_u32_t *result)
 Get an unsigned 32-bit integer field. More...
 
MAMAExpDLL mama_status mamaMsg_getI64 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_i64_t *result)
 Get a I64, signed 64 bit integer, field. More...
 
MAMAExpDLL mama_status mamaMsg_getU64 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_u64_t *result)
 Get an unsigned 64-bit integer field. More...
 
MAMAExpDLL mama_status mamaMsg_getF32 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_f32_t *result)
 Get a float (f32) field. More...
 
MAMAExpDLL mama_status mamaMsg_getF64 (const mamaMsg msg, const char *name, mama_fid_t fid, mama_f64_t *result)
 Get a f64 field. More...
 
MAMAExpDLL mama_status mamaMsg_getString (const mamaMsg msg, const char *name, mama_fid_t fid, const char **result)
 Get a const char * field. More...
 
MAMAExpDLL mama_status mamaMsg_getOpaque (const mamaMsg msg, const char *name, mama_fid_t fid, const void **result, mama_size_t *size)
 Get an opaque field. More...
 
MAMAExpDLL mama_status mamaMsg_getField (const mamaMsg msg, const char *name, mama_fid_t fid, mamaMsgField *result)
 Get a MAMA msg field. More...
 
MAMAExpDLL mama_status mamaMsg_getDateTime (const mamaMsg msg, const char *name, mama_fid_t fid, mamaDateTime result)
 Get a MAMA date/time field. More...
 
MAMAExpDLL mama_status mamaMsg_getDateTimeMSec (const mamaMsg msg, const char *name, mama_fid_t fid, mama_u64_t *milliseconds)
 Get the value of a MAMA date/time field in milliseconds. More...
 
MAMAExpDLL mama_status mamaMsg_getPrice (const mamaMsg msg, const char *name, mama_fid_t fid, mamaPrice result)
 Get a MAMA price field. More...
 
MAMAExpDLL mama_status mamaMsg_getMsg (const mamaMsg msg, const char *name, mama_fid_t fid, mamaMsg *result)
 Get a submessage. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorBool (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_bool_t **result, mama_size_t *resultLen)
 Get a vector of booleans. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorChar (const mamaMsg msg, const char *name, mama_fid_t fid, const char **result, mama_size_t *resultLen)
 Get a vector of chars. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorI8 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_i8_t **result, mama_size_t *resultLen)
 Get a vector of signed 8 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorU8 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_u8_t **result, mama_size_t *resultLen)
 Get a vector of unsigned 8 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorI16 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_i16_t **result, mama_size_t *resultLen)
 Get a vector of signed 16 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorU16 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_u16_t **result, mama_size_t *resultLen)
 Get a vector of unsigned 16 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorI32 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_i32_t **result, mama_size_t *resultLen)
 Get a vector of signed 32 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorU32 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_u32_t **result, mama_size_t *resultLen)
 Get a vector of unsigned 32 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorI64 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_i64_t **result, mama_size_t *resultLen)
 Get a vector of signed 64 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorU64 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_u64_t **result, mama_size_t *resultLen)
 Get a vector of unsigned 64 bit integers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorF32 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_f32_t **result, mama_size_t *resultLen)
 Get a vector of 32 bit floating point numbers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorF64 (const mamaMsg msg, const char *name, mama_fid_t fid, const mama_f64_t **result, mama_size_t *resultLen)
 Get a vector of 64 bit floating point numbers. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorString (const mamaMsg msg, const char *name, mama_fid_t fid, const char ***result, mama_size_t *resultLen)
 Get a vector of strings (char*). More...
 
MAMAExpDLL mama_status mamaMsg_getVectorDateTime (const mamaMsg msg, const char *name, mama_fid_t fid, const mamaDateTime *result, mama_size_t *resultLen)
 Get a vector of timestamps. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorPrice (const mamaMsg msg, const char *name, mama_fid_t fid, const mamaPrice *result, mama_size_t *resultLen)
 Get a vector of prices. More...
 
MAMAExpDLL mama_status mamaMsg_getVectorMsg (const mamaMsg msg, const char *name, mama_fid_t fid, const mamaMsg **result, mama_size_t *resultLen)
 Get a vector of submessages. More...
 
MAMAExpDLL mama_status mamaMsg_getNumFields (const mamaMsg msg, mama_size_t *numFields)
 Returns the total number of fields in the message. More...
 
MAMAExpDLL const char * mamaMsg_toString (const mamaMsg msg)
 Return a const char * representation the message. More...
 
MAMAExpDLL void mamaMsg_freeString (const mamaMsg msg, const char *msgString)
 Free the memory allocated by mamaMsg_toString. More...
 
MAMAExpDLL mama_status mamaMsg_getEntitleCode (const mamaMsg msg, mama_i32_t *code)
 Get the entitle code for this message. More...
 
MAMAExpDLL mama_status mamaMsg_getSeqNum (const mamaMsg msg, mama_seqnum_t *seqNum)
 Get the sequence number for this message if available. More...
 
MAMAExpDLL mamaMsgType mamaMsgType_typeForMsg (const mamaMsg msg)
 Extract the type from the supplied message. More...
 
MAMAExpDLL const char * mamaMsgType_stringForMsg (const mamaMsg msg)
 Return the type name. More...
 
MAMAExpDLL const char * mamaMsgType_stringForType (const mamaMsgType type)
 Return the type name. More...
 
MAMAExpDLL mama_status mamaMsg_getFieldAsString (const mamaMsg msg, const char *fieldName, mama_fid_t fid, char *buf, mama_size_t length)
 Convert the value of the specified field to a string. More...
 
MAMAExpDLL mama_status mamaMsg_iterateFields (const mamaMsg msg, mamaMsgIteratorCb callback, const mamaDictionary dict, void *closure)
 Invoke the specified callback for each field in the message. More...
 
MAMAExpDLL mama_status mamaMsg_getPlatformError (const mamaMsg msg, void **error)
 Return the middleware specific platform error. More...
 
MAMAExpDLL int mamaMsg_isFromInbox (const mamaMsg msg)
 Return true if this message was sent from a client's inbox. More...
 
MAMAExpDLL mama_status mamaMsg_createFromByteBuffer (mamaMsg *msg, const void *buffer, mama_size_t bufferLength)
 Create a mamaMsg from the provided byte buffer. More...
 
MAMAExpDLL mama_status mamaMsg_getByteBuffer (const mamaMsg msg, const void **buffer, mama_size_t *bufferLength)
 Return the internal message buffer as an array of bytes which is suitable for writing to a file. More...
 
MAMAExpDLL mama_status mamaMsg_detach (mamaMsg msg)
 Normally the Mama API owns incoming mamaMsg objects and they go out of scope when the message callback returns. More...
 
MAMAExpDLL mama_status mamaMsg_getIsDefinitelyDuplicate (mamaMsg msg, int *result)
 Return true if this message is definitely a duplicate message. More...
 
MAMAExpDLL mama_status mamaMsg_getIsPossiblyDuplicate (mamaMsg msg, int *result)
 Return true if this message is possibly a duplicate message. More...
 
MAMAExpDLL mama_status mamaMsg_getIsPossiblyDelayed (mamaMsg msg, int *result)
 Return true if the message is possibly delayed. More...
 
MAMAExpDLL mama_status mamaMsg_getIsDefinitelyDelayed (mamaMsg msg, int *result)
 Return true if the message is delayed. More...
 
MAMAExpDLL mama_status mamaMsg_getIsOutOfSequence (mamaMsg msg, int *result)
 Return true when the FH sends the message out of sequence. More...
 
MAMAExpDLL mama_status mamaMsg_setNewBuffer (mamaMsg msg, void *buffer, mama_size_t size)
 Set a new buffer for an existing mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsg_getNativeHandle (const mamaMsg msg, void **result)
 Get the native middleware message handle. More...
 
MAMAExpDLL mama_status mamaMsgIterator_create (mamaMsgIterator *iterator, mamaDictionary dict)
 Creates a new iterator for use with a mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsgIterator_associate (mamaMsgIterator iterator, mamaMsg msg)
 Associate an iterator for use with a mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsgIterator_setDict (mamaMsgIterator iterator, mamaDictionary dict)
 Associate a mamaDictionary for use with an iterator. More...
 
MAMAExpDLL mamaMsgField mamaMsgIterator_next (mamaMsgIterator iterator)
 Return the next field in the mamaMsg. More...
 
MAMAExpDLL mama_bool_t mamaMsgIterator_hasNext (mamaMsgIterator iterator)
 Return whether there is a next next field in the mamaMsg. More...
 
MAMAExpDLL mamaMsgField mamaMsgIterator_begin (mamaMsgIterator iterator)
 Set iterator to first field in mamaMsg. More...
 
MAMAExpDLL mamaMsgField mamaMsgIterator_end (mamaMsgIterator iterator)
 Set iterator to last field in mamaMsg. More...
 
MAMAExpDLL mama_status mamaMsgIterator_destroy (mamaMsgIterator iterator)
 Destroy iterator. More...
 

Macro Definition Documentation

◆ ENTITLE_FIELD_NAME

#define ENTITLE_FIELD_NAME   "wEntitleCode"

◆ ENTITLE_FIELD_ID

#define ENTITLE_FIELD_ID   496

Typedef Documentation

◆ mamaPayloadType

Enum to reference the available MAMA message payloads.

◆ mamaMsgIteratorCb

typedef void(MAMACALLTYPE * mamaMsgIteratorCb) (const mamaMsg msg, const mamaMsgField field, void *closure)

Iterator callback method is invoked for each field in the message.

Parameters
msgThe message.
fieldThe field.
closureThe closure specified in mamaMsg_iterateFields().

Enumeration Type Documentation

◆ mamaPayloadType_

Enum to reference the available MAMA message payloads.

Enumerator
MAMA_PAYLOAD_WOMBAT_MSG 
MAMA_PAYLOAD_TIBRV 
MAMA_PAYLOAD_FAST 
MAMA_PAYLOAD_V5 
MAMA_PAYLOAD_AVIS 
MAMA_PAYLOAD_TICK42BLP 
MAMA_PAYLOAD_RAI 
MAMA_PAYLOAD_EXEGY 
MAMA_PAYLOAD_UNKNOWN 
44 {
46  MAMA_PAYLOAD_TIBRV = 'R',
47  MAMA_PAYLOAD_FAST = 'F',
48  MAMA_PAYLOAD_V5 = '5',
49  MAMA_PAYLOAD_AVIS = 'A',
51  MAMA_PAYLOAD_RAI = 'I',
52  MAMA_PAYLOAD_EXEGY = 'X',
Definition: msg.h:47
Definition: msg.h:52
Definition: msg.h:51
Definition: msg.h:53
Definition: msg.h:46
Definition: msg.h:48
Definition: msg.h:50
Definition: msg.h:49
Definition: msg.h:45
enum mamaPayloadType_ mamaPayloadType
Enum to reference the available MAMA message payloads.

Function Documentation

◆ mamaPayload_convertToString()

MAMAExpDLL const char* mamaPayload_convertToString ( mamaPayloadType  payloadType)

Convert a mamaPayloadType value to a string.

Do no attempt to free the string result.

Parameters
payloadTypeThe payloadType to convert.

◆ mamaMsg_create()

MAMAExpDLL mama_status mamaMsg_create ( mamaMsg msg)

Create a mamaMsg.

Parameters
msgThe location of a mamaMsg where to store the result.

◆ mamaMsg_createForPayload()

MAMAExpDLL mama_status mamaMsg_createForPayload ( mamaMsg msg,
const char  id 
)

Create a mamaMsg.

Parameters
msgThe location of a mamaMsg where to store the result.
idThe identifier of the payload to be used.

◆ mamaMsg_createForPayloadBridge()

MAMAExpDLL mama_status mamaMsg_createForPayloadBridge ( mamaMsg msg,
mamaPayloadBridge  payloadBridge 
)

Create a mamaMsg.

Parameters
msgThe location of a mamaMsg where to store the result.
idThe payload bridge to be used.

◆ mamaMsg_createForTemplate()

MAMAExpDLL mama_status mamaMsg_createForTemplate ( mamaMsg msg,
mama_u32_t  templateId 
)

Create a mamaMsg for a particular template ID.

Parameters
msgThe location of a mamaMsg where to store the result.
templateIDThe wombatMsg to encapsulate.

◆ mamaMsg_copy()

MAMAExpDLL mama_status mamaMsg_copy ( mamaMsg  src,
mamaMsg copy 
)

Copy a mamaMsg.

If mamaMsg_create() has not been called for for the destination message object then this will be done by the function.

Parameters
srcThe message to copy.
copyA pointer to the destination message.

◆ mamaMsg_getTempCopy()

MAMAExpDLL mama_status mamaMsg_getTempCopy ( mamaMsg  src,
mamaMsg copy 
)

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 function is called and then the same copy is returned when this function is called again. The copy is destroyed when the original message is destroyed.

Parameters
srcThe message to copy.
copyA pointer to the destination message.

◆ mamaMsg_clear()

MAMAExpDLL mama_status mamaMsg_clear ( mamaMsg  msg)

Clear a msg.

All fields are removed.

Parameters
msgThe mamaMsg to clear.

◆ mamaMsg_getSendSubject()

MAMAExpDLL mama_status mamaMsg_getSendSubject ( const mamaMsg  msg,
const char **  subject 
)

TIB/RV only.

Get the TIB/RV send subject from the message. For other message types MAMA_STATUS_NOT_IMPLEMENTED will be returned.

Parameters
srcThe message to copy.
copyA pointer to the destination message.

◆ mamaMsg_destroy()

MAMAExpDLL mama_status mamaMsg_destroy ( mamaMsg  msg)

Destroy a message and free any resources associated with it.

Parameters
msgThe message.

◆ mamaMsg_getPayloadType()

MAMAExpDLL mama_status mamaMsg_getPayloadType ( mamaMsg  msg,
mamaPayloadType payloadType 
)

Get the type of the message payload.

Parameters
msgThe message.
payloadTypeThe payload type.

◆ mamaMsg_getByteSize()

MAMAExpDLL mama_status mamaMsg_getByteSize ( const mamaMsg  msg,
mama_size_t size 
)

Get the size of the underlying message in bytes.

Only works for tibrvMsg and wombatmsg types.

Parameters
msgThe MAMA message
size(out) The size of the message in bytes
Returns
Resulting status of the call

◆ mamaMsg_addBool()

MAMAExpDLL mama_status mamaMsg_addBool ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_bool_t  value 
)

Add a new bool field.

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

◆ mamaMsg_addChar()

MAMAExpDLL mama_status mamaMsg_addChar ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
char  value 
)

Add a new char field.

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

◆ mamaMsg_addI8()

MAMAExpDLL mama_status mamaMsg_addI8 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i8_t  value 
)

Add a new 8 bit signed int field.

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

◆ mamaMsg_addU8()

MAMAExpDLL mama_status mamaMsg_addU8 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u8_t  value 
)

Add a new 8 bit unsigned int field.

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

◆ mamaMsg_addI16()

MAMAExpDLL mama_status mamaMsg_addI16 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i16_t  value 
)

Add a new 16 bit signed int field.

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

◆ mamaMsg_addU16()

MAMAExpDLL mama_status mamaMsg_addU16 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u16_t  value 
)

Add a new 16 bit unsigned int field.

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

◆ mamaMsg_addI32()

MAMAExpDLL mama_status mamaMsg_addI32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i32_t  value 
)

Add a new 32 bit unsigned int field.

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

◆ mamaMsg_addU32()

MAMAExpDLL mama_status mamaMsg_addU32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u32_t  value 
)

Add a new 32 bit signed int field.

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

◆ mamaMsg_addI64()

MAMAExpDLL mama_status mamaMsg_addI64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i64_t  value 
)

Add a new I64 field.

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

◆ mamaMsg_addU64()

MAMAExpDLL mama_status mamaMsg_addU64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u64_t  value 
)

Add a new U64 field.

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

◆ mamaMsg_addF32()

MAMAExpDLL mama_status mamaMsg_addF32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_f32_t  value 
)

Add a new float (f32) field.

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

◆ mamaMsg_addF64()

MAMAExpDLL mama_status mamaMsg_addF64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_f64_t  value 
)

Add a new f64 field.

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

◆ mamaMsg_addString()

MAMAExpDLL mama_status mamaMsg_addString ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const char *  value 
)

Add a const char * field.

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

◆ mamaMsg_addOpaque()

MAMAExpDLL mama_status mamaMsg_addOpaque ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const void *  value,
mama_size_t  size 
)

Add an opaque field.

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

◆ mamaMsg_addDateTime()

MAMAExpDLL mama_status mamaMsg_addDateTime ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaDateTime  value 
)

Add a MAMA date/time field.

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

◆ mamaMsg_addPrice()

MAMAExpDLL mama_status mamaMsg_addPrice ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaPrice  value 
)

Add a MAMA price field.

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

◆ mamaMsg_addMsg()

MAMAExpDLL mama_status mamaMsg_addMsg ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaMsg  value 
)

Add a mamaMsg object to the message.

Parameters
msgThe message to which the field is being added.
nameThe name identifier for the field (optional).
fidThe field identifier
valueThe value of the field
Returns
mama_status MAMA_STATUS_OK if the function executes successfully

◆ mamaMsg_addVectorBool()

MAMAExpDLL mama_status mamaMsg_addVectorBool ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_bool_t  value[],
mama_size_t  numElements 
)

Add an array of booleans to the message.

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of booleans.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorChar()

MAMAExpDLL mama_status mamaMsg_addVectorChar ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const char  value[],
mama_size_t  numElements 
)

Add an array of characters to the message.

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of characters.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorI8()

MAMAExpDLL mama_status mamaMsg_addVectorI8 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i8_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of signed 8 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorU8()

MAMAExpDLL mama_status mamaMsg_addVectorU8 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u8_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of unsigned 8 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorI16()

MAMAExpDLL mama_status mamaMsg_addVectorI16 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i16_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of signed 16 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorU16()

MAMAExpDLL mama_status mamaMsg_addVectorU16 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u16_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of unsigned 16 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorI32()

MAMAExpDLL mama_status mamaMsg_addVectorI32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i32_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of signed 32 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorU32()

MAMAExpDLL mama_status mamaMsg_addVectorU32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u32_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of unsigned 32 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorI64()

MAMAExpDLL mama_status mamaMsg_addVectorI64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i64_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of signed 64 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorU64()

MAMAExpDLL mama_status mamaMsg_addVectorU64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u64_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of unsigned 64 bit integers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorF32()

MAMAExpDLL mama_status mamaMsg_addVectorF32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_f32_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of 32 bit floating point numbers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorF64()

MAMAExpDLL mama_status mamaMsg_addVectorF64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_f64_t  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of 64 bit floating point numbers.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorString()

MAMAExpDLL mama_status mamaMsg_addVectorString ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const char *  value[],
mama_size_t  numElements 
)

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

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of strings (char*).
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorMsg()

MAMAExpDLL mama_status mamaMsg_addVectorMsg ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaMsg  value[],
mama_size_t  numElements 
)

Add an array of mamaMsg objects to the message.

Parameters
msgThe message to which the field is being added.
nameThe name identifier for the field (optional).
fidThe field identifier
value[]The value of the field.
numElementsThe number of elements in the mamaMsg array.
Returns
mama_status MAMA_STATUS_OK if the function returns successfully.

◆ mamaMsg_addVectorDateTime()

MAMAExpDLL mama_status mamaMsg_addVectorDateTime ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaDateTime  value[],
mama_size_t  numElements 
)

Add an array of timestamps to the message.

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of timestamps.
numElementsThe number of elements in the array.

◆ mamaMsg_addVectorPrice()

MAMAExpDLL mama_status mamaMsg_addVectorPrice ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaPrice  value[],
mama_size_t  numElements 
)

Add an array of prices to the message.

Parameters
msgThe mamaMsg
nameThe name identifier for the field (optional).
fidThe field identifier.
value[]Array of values.
numElementsThe number of elements in the array.

◆ mamaMsg_updateBool()

MAMAExpDLL mama_status mamaMsg_updateBool ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_bool_t  value 
)

Update the value of an existing bool field.

If the field does not exist it is added.

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

◆ mamaMsg_updateChar()

MAMAExpDLL mama_status mamaMsg_updateChar ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
char  value 
)

Update the value of an existing char field.

If the field does not exist it is added.

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

◆ mamaMsg_updateI8()

MAMAExpDLL mama_status mamaMsg_updateI8 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i8_t  value 
)

Update the value of an existing I8 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateU8()

MAMAExpDLL mama_status mamaMsg_updateU8 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u8_t  value 
)

Update the value of an existing U8 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateI16()

MAMAExpDLL mama_status mamaMsg_updateI16 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i16_t  value 
)

Update the value of an existing I16 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateU16()

MAMAExpDLL mama_status mamaMsg_updateU16 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u16_t  value 
)

Update the value of an existing U16 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateI32()

MAMAExpDLL mama_status mamaMsg_updateI32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i32_t  value 
)

Update the value of an existing I32 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateU32()

MAMAExpDLL mama_status mamaMsg_updateU32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u32_t  value 
)

Update the value of an existing U32 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateI64()

MAMAExpDLL mama_status mamaMsg_updateI64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i64_t  value 
)

Update the value of an existing I64 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateU64()

MAMAExpDLL mama_status mamaMsg_updateU64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u64_t  value 
)

Update the value of an existing U64 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateF32()

MAMAExpDLL mama_status mamaMsg_updateF32 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_f32_t  value 
)

Update the value of an existing float field.

If the field does not exist it is added.

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

◆ mamaMsg_updateF64()

MAMAExpDLL mama_status mamaMsg_updateF64 ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_f64_t  value 
)

Update the value of an existing f64 field.

If the field does not exist it is added.

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

◆ mamaMsg_updateString()

MAMAExpDLL mama_status mamaMsg_updateString ( mamaMsg  msg,
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
msgThe message.
nameThe name.
fidThe field identifier.
valueThe new value.

◆ mamaMsg_updateOpaque()

MAMAExpDLL mama_status mamaMsg_updateOpaque ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const void *  value,
mama_size_t  size 
)

Update an opaque field.

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

◆ mamaMsg_updateDateTime()

MAMAExpDLL mama_status mamaMsg_updateDateTime ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaDateTime  value 
)

Update a MAMA date/time field.

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

◆ mamaMsg_updatePrice()

MAMAExpDLL mama_status mamaMsg_updatePrice ( mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaPrice  value 
)

Update a MAMA price field.

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

◆ mamaMsg_getBool()

MAMAExpDLL mama_status mamaMsg_getBool ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_bool_t result 
)

Get a bool field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_applyMsg()

MAMAExpDLL mama_status mamaMsg_applyMsg ( mamaMsg  dest,
mamaMsg  src 
)

Apply the contents of one message to another as updates.

Parameters
destThe message to update.
srcThe source messages.

◆ mamaMsg_getNativeMsg()

MAMAExpDLL mama_status mamaMsg_getNativeMsg ( mamaMsg  msg,
void **  nativeMsg 
)

Get the native message structure for the underlying message This function is for internal NYSE Technologies use only.

Parameters
msgThe message
nativeMsgThe resulting native handle.
Returns
mama_status Returns MAMA_STATUS_OK if the call was successful.

◆ mamaMsg_getReplyHandle()

MAMAExpDLL mama_status mamaMsg_getReplyHandle ( mamaMsg  msg,
mamaMsgReply replyHandle 
)

Get the reply handle for the message and increments the reference count for the handle.

Parameters
msgThe message
replyHandleThe resulting reply handle.
Returns
mama_status Returns MAMA_STATUS_OK if the call was successful.

◆ mamaMsg_setReplyHandle()

MAMAExpDLL mama_status mamaMsg_setReplyHandle ( mamaMsg  msg,
mamaMsgReply  replyHandle 
)

Set the reply handle for the message and increments the reference count for the handle.

Parameters
msgThe message
replyHandleThe reply handle for this message.
Returns
mama_status Returns MAMA_STATUS_OK if the call was successful.

◆ mamaMsg_copyReplyHandle()

MAMAExpDLL mama_status mamaMsg_copyReplyHandle ( mamaMsgReply  src,
mamaMsgReply copy 
)

Create a new copy of the src reply handle.

Parameters
srcThe reply handler to copy.
copyA pointer to the destination reply handle.
Returns
mama_status Returns MAMA_STATUS_OK if the call was successful.

◆ mamaMsg_destroyReplyHandle()

MAMAExpDLL mama_status mamaMsg_destroyReplyHandle ( mamaMsgReply  replyHandle)

Destroys a reply handle.

Parameters
replyHandleThe reply handle for this message.
Returns
mama_status Returns MAMA_STATUS_OK if the call was successful.

◆ mamaMsg_updateSubMsg()

MAMAExpDLL mama_status mamaMsg_updateSubMsg ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mamaMsg  subMsg 
)

Update a sub-message field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
subMsgThe new value.

◆ mamaMsg_updateVectorMsg()

MAMAExpDLL mama_status mamaMsg_updateVectorMsg ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mamaMsg  msgList[],
mama_size_t  numElements 
)

Update a vector message field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
msgListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorString()

MAMAExpDLL mama_status mamaMsg_updateVectorString ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const char *  strList[],
mama_size_t  numElements 
)

Update a vector string field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
strListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorBool()

MAMAExpDLL mama_status mamaMsg_updateVectorBool ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_bool_t  boolList[],
mama_size_t  numElements 
)

Update a vector bool field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
boolListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorChar()

MAMAExpDLL mama_status mamaMsg_updateVectorChar ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const char  charList[],
mama_size_t  numElements 
)

Update a vector char field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
charListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorI8()

MAMAExpDLL mama_status mamaMsg_updateVectorI8 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_i8_t  i8List[],
mama_size_t  numElements 
)

Update a vector I8 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
i8ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorU8()

MAMAExpDLL mama_status mamaMsg_updateVectorU8 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_u8_t  u8List[],
mama_size_t  numElements 
)

Update a vector U8 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
u8ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorI16()

MAMAExpDLL mama_status mamaMsg_updateVectorI16 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_i16_t  i16List[],
mama_size_t  numElements 
)

Update a vector I16 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
i16ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorU16()

MAMAExpDLL mama_status mamaMsg_updateVectorU16 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_u16_t  u16List[],
mama_size_t  numElements 
)

Update a vector U16 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
u16ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorI32()

MAMAExpDLL mama_status mamaMsg_updateVectorI32 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_i32_t  i32List[],
mama_size_t  numElements 
)

Update a vector I32 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
i32ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorU32()

MAMAExpDLL mama_status mamaMsg_updateVectorU32 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_u32_t  u32List[],
mama_size_t  numElements 
)

Update a vector U32 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
u32ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorI64()

MAMAExpDLL mama_status mamaMsg_updateVectorI64 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_i64_t  i64List[],
mama_size_t  numElements 
)

Update a vector I64 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
i64ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorU64()

MAMAExpDLL mama_status mamaMsg_updateVectorU64 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_u64_t  u64List[],
mama_size_t  numElements 
)

Update a vector U64 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
u64ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorF32()

MAMAExpDLL mama_status mamaMsg_updateVectorF32 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_f32_t  f32List[],
mama_size_t  numElements 
)

Update a vector F32 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
f32ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorF64()

MAMAExpDLL mama_status mamaMsg_updateVectorF64 ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mama_f64_t  f64List[],
mama_size_t  numElements 
)

Update a vector F64 field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
f64ListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorPrice()

MAMAExpDLL mama_status mamaMsg_updateVectorPrice ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mamaPrice priceList[],
mama_size_t  numElements 
)

Update a vector price field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
priceListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_updateVectorTime()

MAMAExpDLL mama_status mamaMsg_updateVectorTime ( mamaMsg  msg,
const char *  fname,
mama_fid_t  fid,
const mamaDateTime  timeList[],
mama_size_t  numElements 
)

Update a vector mamaDateTime field.

Parameters
msgThe message.
fnameThe name
fidThe field identifier
timeListThe new value.
numElementsthe number of elements in the vector

◆ mamaMsg_getChar()

MAMAExpDLL mama_status mamaMsg_getChar ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
char *  result 
)

Get a char field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getI8()

MAMAExpDLL mama_status mamaMsg_getI8 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i8_t result 
)

Get a I8, signed 8 bit integer, field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getU8()

MAMAExpDLL mama_status mamaMsg_getU8 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u8_t result 
)

Get an unsigned 8-bit integer field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getI16()

MAMAExpDLL mama_status mamaMsg_getI16 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i16_t result 
)

Get a I16, signed 16 bit integer, field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getU16()

MAMAExpDLL mama_status mamaMsg_getU16 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u16_t result 
)

Get an unsigned 16-bit integer field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getI32()

MAMAExpDLL mama_status mamaMsg_getI32 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i32_t result 
)

Get a I32, signed 32 bit integer, field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getU32()

MAMAExpDLL mama_status mamaMsg_getU32 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u32_t result 
)

Get an unsigned 32-bit integer field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getI64()

MAMAExpDLL mama_status mamaMsg_getI64 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_i64_t result 
)

Get a I64, signed 64 bit integer, field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getU64()

MAMAExpDLL mama_status mamaMsg_getU64 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u64_t result 
)

Get an unsigned 64-bit integer field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getF32()

MAMAExpDLL mama_status mamaMsg_getF32 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_f32_t result 
)

Get a float (f32) field.

Parameters
msgThe message.
nameThe name.
fidThe field identifier.
result(out) The double value.

◆ mamaMsg_getF64()

MAMAExpDLL mama_status mamaMsg_getF64 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_f64_t result 
)

Get a f64 field.

Parameters
msgThe message.
nameThe name.
fidThe field identifier.
result(out) The double value.

◆ mamaMsg_getString()

MAMAExpDLL mama_status mamaMsg_getString ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const char **  result 
)

Get a const char * field.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
result(out) the string value.

◆ mamaMsg_getOpaque()

MAMAExpDLL mama_status mamaMsg_getOpaque ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const void **  result,
mama_size_t size 
)

Get an opaque field.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
result(out) The opaque value.
size(out) Length in bytes of the opaque field.

◆ mamaMsg_getField()

MAMAExpDLL mama_status mamaMsg_getField ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mamaMsgField result 
)

Get a MAMA msg field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result. The result contains the reusable field object of the mamaMsg object. Applications calling this method will receive the same reusable object for repeated calls on same mamaMsg object.

◆ mamaMsg_getDateTime()

MAMAExpDLL mama_status mamaMsg_getDateTime ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mamaDateTime  result 
)

Get a MAMA date/time field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getDateTimeMSec()

MAMAExpDLL mama_status mamaMsg_getDateTimeMSec ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mama_u64_t milliseconds 
)

Get the value of a MAMA date/time field in milliseconds.

Parameters
msgThe message.
nameThe name
fidThe field identifier
milliseconds(out) Pointer to the value in milliseconds

◆ mamaMsg_getPrice()

MAMAExpDLL mama_status mamaMsg_getPrice ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mamaPrice  result 
)

Get a MAMA price field.

Parameters
msgThe message.
nameThe name
fidThe field identifier
result(out) Pointer to the result

◆ mamaMsg_getMsg()

MAMAExpDLL mama_status mamaMsg_getMsg ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
mamaMsg result 
)

Get a submessage.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result. result when the method returns..

◆ mamaMsg_getVectorBool()

MAMAExpDLL mama_status mamaMsg_getVectorBool ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_bool_t **  result,
mama_size_t resultLen 
)

Get a vector of booleans.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorChar()

MAMAExpDLL mama_status mamaMsg_getVectorChar ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const char **  result,
mama_size_t resultLen 
)

Get a vector of chars.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorI8()

MAMAExpDLL mama_status mamaMsg_getVectorI8 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i8_t **  result,
mama_size_t resultLen 
)

Get a vector of signed 8 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorU8()

MAMAExpDLL mama_status mamaMsg_getVectorU8 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u8_t **  result,
mama_size_t resultLen 
)

Get a vector of unsigned 8 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorI16()

MAMAExpDLL mama_status mamaMsg_getVectorI16 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i16_t **  result,
mama_size_t resultLen 
)

Get a vector of signed 16 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorU16()

MAMAExpDLL mama_status mamaMsg_getVectorU16 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u16_t **  result,
mama_size_t resultLen 
)

Get a vector of unsigned 16 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorI32()

MAMAExpDLL mama_status mamaMsg_getVectorI32 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i32_t **  result,
mama_size_t resultLen 
)

Get a vector of signed 32 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorU32()

MAMAExpDLL mama_status mamaMsg_getVectorU32 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u32_t **  result,
mama_size_t resultLen 
)

Get a vector of unsigned 32 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorI64()

MAMAExpDLL mama_status mamaMsg_getVectorI64 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_i64_t **  result,
mama_size_t resultLen 
)

Get a vector of signed 64 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorU64()

MAMAExpDLL mama_status mamaMsg_getVectorU64 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_u64_t **  result,
mama_size_t resultLen 
)

Get a vector of unsigned 64 bit integers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorF32()

MAMAExpDLL mama_status mamaMsg_getVectorF32 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_f32_t **  result,
mama_size_t resultLen 
)

Get a vector of 32 bit floating point numbers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorF64()

MAMAExpDLL mama_status mamaMsg_getVectorF64 ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mama_f64_t **  result,
mama_size_t resultLen 
)

Get a vector of 64 bit floating point numbers.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorString()

MAMAExpDLL mama_status mamaMsg_getVectorString ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const char ***  result,
mama_size_t resultLen 
)

Get a vector of strings (char*).

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorDateTime()

MAMAExpDLL mama_status mamaMsg_getVectorDateTime ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaDateTime result,
mama_size_t resultLen 
)

Get a vector of timestamps.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorPrice()

MAMAExpDLL mama_status mamaMsg_getVectorPrice ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaPrice result,
mama_size_t resultLen 
)

Get a vector of prices.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getVectorMsg()

MAMAExpDLL mama_status mamaMsg_getVectorMsg ( const mamaMsg  msg,
const char *  name,
mama_fid_t  fid,
const mamaMsg **  result,
mama_size_t resultLen 
)

Get a vector of submessages.

Parameters
msgThe message.
nameThe field name.
fidThe field identifier.
resultA pointer to the result.
resultLenAn integer pointer that will contain the length of the result when the method returns..

◆ mamaMsg_getNumFields()

MAMAExpDLL mama_status mamaMsg_getNumFields ( const mamaMsg  msg,
mama_size_t numFields 
)

Returns the total number of fields in the message.

Sub-messages count as a single field.

Parameters
msgThe message.
numFields(out) The number of fields in the message.

◆ mamaMsg_toString()

MAMAExpDLL const char* mamaMsg_toString ( const mamaMsg  msg)

Return a const char * representation the message.

Must call mamaMsg_freeString() to free memory allocated for string.

Parameters
msgThe message.
Returns
A string representation of the message.

◆ mamaMsg_freeString()

MAMAExpDLL void mamaMsg_freeString ( const mamaMsg  msg,
const char *  msgString 
)

Free the memory allocated by mamaMsg_toString.

Parameters
msgThe message.
msgStringThe string allocated by mamaMsg_toString

◆ mamaMsg_getEntitleCode()

MAMAExpDLL mama_status mamaMsg_getEntitleCode ( const mamaMsg  msg,
mama_i32_t code 
)

Get the entitle code for this message.

The result defaults to 0 (no entitlement) if the field is not present.

Parameters
msgThe message.
code(out) The entitle code

◆ mamaMsg_getSeqNum()

MAMAExpDLL mama_status mamaMsg_getSeqNum ( const mamaMsg  msg,
mama_seqnum_t seqNum 
)

Get the sequence number for this message if available.

The result defaults to 0 and MAMA_STATUS_NOT_FOUND retuned if the field is not present.

Parameters
msgThe message.
code(out) The sequence number.

◆ mamaMsgType_typeForMsg()

MAMAExpDLL mamaMsgType mamaMsgType_typeForMsg ( const mamaMsg  msg)

Extract the type from the supplied message.

Parameters
msgThe message.
Returns
The type.

◆ mamaMsgType_stringForMsg()

MAMAExpDLL const char* mamaMsgType_stringForMsg ( const mamaMsg  msg)

Return the type name.

Parameters
msgThe message.
Returns
The type name.

◆ mamaMsgType_stringForType()

MAMAExpDLL const char* mamaMsgType_stringForType ( const mamaMsgType  type)

Return the type name.

Parameters
typeThe message.
Returns
The type name.

◆ mamaMsg_getFieldAsString()

MAMAExpDLL mama_status mamaMsg_getFieldAsString ( const mamaMsg  msg,
const char *  fieldName,
mama_fid_t  fid,
char *  buf,
mama_size_t  length 
)

Convert the value of the specified field to a string.

Caller must provide a buffer for the value.

Parameters
msgThe message.
fieldNameThe field name.
fidThe field identifier.
bufThe buffer where the resulting string will be copied.
lengthThe length of the caller supplied buffer.

◆ mamaMsg_iterateFields()

MAMAExpDLL mama_status mamaMsg_iterateFields ( const mamaMsg  msg,
mamaMsgIteratorCb  callback,
const mamaDictionary  dict,
void *  closure 
)

Invoke the specified callback for each field in the message.

Parameters
msgThe message.
callbackThe msgIteratorCb to invoke.
dictThe dictionary.
closureThe user specified closure passed to the callback.

◆ mamaMsg_getPlatformError()

MAMAExpDLL mama_status mamaMsg_getPlatformError ( const mamaMsg  msg,
void **  error 
)

Return the middleware specific platform error.

When a mamaSubscription_ method returns MAMA_STATUS_PLATFORM the error will be the result from the underlying platform.

Parameters
msgThe message.
error(out) The platform dependent result.

◆ mamaMsg_isFromInbox()

MAMAExpDLL int mamaMsg_isFromInbox ( const mamaMsg  msg)

Return true if this message was sent from a client's inbox.

◆ mamaMsg_createFromByteBuffer()

MAMAExpDLL mama_status mamaMsg_createFromByteBuffer ( mamaMsg msg,
const void *  buffer,
mama_size_t  bufferLength 
)

Create a mamaMsg from the provided byte buffer.

The application is responsible for destroying the message. In this function a copy of the buffer isn't made and the client must maintain it until after the message has been destroyed using the mamaMsg_destroy function. The function can determine from the buffer whether it is a wombatmsg or the native format for the transport being used.

Any transport differences are detailed below.

rv: The bufferLength parameter is not required.

Parameters
msgThe mamaMsg object
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

◆ mamaMsg_getByteBuffer()

MAMAExpDLL mama_status mamaMsg_getByteBuffer ( const mamaMsg  msg,
const void **  buffer,
mama_size_t bufferLength 
)

Return the internal message buffer as an array of bytes which is suitable for writing to a file.

Do not modify the returned byte buffer as this is the internal message buffer and remains part of the message until it is destroyed. The buffer will be written to the address supplied by the client. The buffer will contain the wire format of the underlying message implementation but does not contain delivery information such as source, topic etc.

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

◆ mamaMsg_detach()

MAMAExpDLL mama_status mamaMsg_detach ( mamaMsg  msg)

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

Calling this method from the message callback transfers ownership, and responsibility for calling mamaMsg_destroy() to the caller.

◆ mamaMsg_getIsDefinitelyDuplicate()

MAMAExpDLL mama_status mamaMsg_getIsDefinitelyDuplicate ( mamaMsg  msg,
int *  result 
)

Return true if this message is definitely a duplicate message.

This condition will not occur with the current feed handlers.

◆ mamaMsg_getIsPossiblyDuplicate()

MAMAExpDLL mama_status mamaMsg_getIsPossiblyDuplicate ( mamaMsg  msg,
int *  result 
)

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.

◆ mamaMsg_getIsPossiblyDelayed()

MAMAExpDLL mama_status mamaMsg_getIsPossiblyDelayed ( mamaMsg  msg,
int *  result 
)

Return true if the message is possibly delayed.

This condition may be true during a fault-tolerant take over.

◆ mamaMsg_getIsDefinitelyDelayed()

MAMAExpDLL mama_status mamaMsg_getIsDefinitelyDelayed ( mamaMsg  msg,
int *  result 
)

Return true if the message is delayed.

This condition may be true during a faul tolerant take over.

◆ mamaMsg_getIsOutOfSequence()

MAMAExpDLL mama_status mamaMsg_getIsOutOfSequence ( mamaMsg  msg,
int *  result 
)

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

◆ mamaMsg_setNewBuffer()

MAMAExpDLL mama_status mamaMsg_setNewBuffer ( mamaMsg  msg,
void *  buffer,
mama_size_t  size 
)

Set a new buffer for an existing mamaMsg.

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

Parameters
msgThe mamaMsg that will receive the new buffer.
bufferThe new buffer to use for this message.
sizeThe size of the buffer.

◆ mamaMsg_getNativeHandle()

MAMAExpDLL mama_status mamaMsg_getNativeHandle ( const mamaMsg  msg,
void **  result 
)

Get the native middleware message handle.

This is only intended for internal use.

◆ mamaMsgIterator_create()

MAMAExpDLL mama_status mamaMsgIterator_create ( mamaMsgIterator iterator,
mamaDictionary  dict 
)

Creates a new iterator for use with a mamaMsg.

Parameters
iteratorPointer to memory to be used for iterator
dictThe mamaDictionary to be associated with the iterator
Returns
mama_status The outcome of the operation

◆ mamaMsgIterator_associate()

MAMAExpDLL mama_status mamaMsgIterator_associate ( mamaMsgIterator  iterator,
mamaMsg  msg 
)

Associate an iterator for use with a mamaMsg.

Parameters
msgThe mamaMsg that will use the iterator
iteratoriterator for use with msg
Returns
mama_status The outcome of the operation

◆ mamaMsgIterator_setDict()

MAMAExpDLL mama_status mamaMsgIterator_setDict ( mamaMsgIterator  iterator,
mamaDictionary  dict 
)

Associate a mamaDictionary for use with an iterator.

Parameters
iteratorThe iterator that will use the dictionary
dictThe dictionary to be used
Returns
mama_status The outcome of the operation.

◆ mamaMsgIterator_next()

MAMAExpDLL mamaMsgField mamaMsgIterator_next ( mamaMsgIterator  iterator)

Return the next field in the mamaMsg.

Parameters
iteratorThe iterator being used
Returns
mamaMsgField The next field in the message

◆ mamaMsgIterator_hasNext()

MAMAExpDLL mama_bool_t mamaMsgIterator_hasNext ( mamaMsgIterator  iterator)

Return whether there is a next next field in the mamaMsg.

Parameters
iteratorThe iterator being used
Returns
bool Does the message have another field

◆ mamaMsgIterator_begin()

MAMAExpDLL mamaMsgField mamaMsgIterator_begin ( mamaMsgIterator  iterator)

Set iterator to first field in mamaMsg.

Parameters
iteratorThe iterator being used
Returns
mamaMsgField The first field in the message

◆ mamaMsgIterator_end()

MAMAExpDLL mamaMsgField mamaMsgIterator_end ( mamaMsgIterator  iterator)

Set iterator to last field in mamaMsg.

Parameters
iteratorThe iterator being used
Returns
mamaMsgField The last field in the message

◆ mamaMsgIterator_destroy()

MAMAExpDLL mama_status mamaMsgIterator_destroy ( mamaMsgIterator  iterator)

Destroy iterator.

Parameters
iteratorThe iterator being destroyed


© 2012 Linux Foundation