msgstatus.h File Reference

#include <mama/msg.h>

Go to the source code of this file.

Typedefs
typedef enum mamaMsgStatus_	mamaMsgStatus
	Utility class (enum) for interpreting message status. More...

Enumerations
enum	mamaMsgStatus_ {   MAMA_MSG_STATUS_OK = 0, MAMA_MSG_STATUS_LINE_DOWN = 1, MAMA_MSG_STATUS_NO_SUBSCRIBERS = 2, MAMA_MSG_STATUS_BAD_SYMBOL = 3,   MAMA_MSG_STATUS_EXPIRED = 4, MAMA_MSG_STATUS_TIMEOUT = 5, MAMA_MSG_STATUS_MISC = 6, MAMA_MSG_STATUS_STALE = 7,   MAMA_MSG_STATUS_TIBRV_STATUS = 8, MAMA_MSG_STATUS_PLATFORM_STATUS = 8, MAMA_MSG_STATUS_NOT_ENTITLED = 9, MAMA_MSG_STATUS_NOT_FOUND = 10,   MAMA_MSG_STATUS_POSSIBLY_STALE = 11, MAMA_MSG_STATUS_NOT_PERMISSIONED = 12, MAMA_MSG_STATUS_TOPIC_CHANGE = 13, MAMA_MSG_STATUS_BANDWIDTH_EXCEEDED = 14,   MAMA_MSG_STATUS_DUPLICATE = 15, MAMA_MSG_STATUS_UNKNOWN = 99 }
	Utility class (enum) for interpreting message status. More...

Functions
MAMAExpDLL mamaMsgStatus	mamaMsgStatus_statusForMsg (const mamaMsg msg)
	Extract the status from the supplied message. More...
MAMAExpDLL const char *	mamaMsgStatus_stringForMsg (const mamaMsg msg)
	Return the status as a string given a message. More...
MAMAExpDLL const char *	mamaMsgStatus_stringForStatus (mamaMsgStatus type)
	Return a text description of the message's status. More...

Typedef Documentation

mamaMsgStatus

typedef enum mamaMsgStatus_ mamaMsgStatus

Utility class (enum) for interpreting message status.

Enumeration Type Documentation

mamaMsgStatus_

enum mamaMsgStatus_

Utility class (enum) for interpreting message status.

Enumerator
MAMA_MSG_STATUS_OK	OK.
MAMA_MSG_STATUS_LINE_DOWN	The feed handler has detected a Line Down.
MAMA_MSG_STATUS_NO_SUBSCRIBERS	The feed handler does not have any subscribers to the subject.
MAMA_MSG_STATUS_BAD_SYMBOL	The symbol does not exist.
MAMA_MSG_STATUS_EXPIRED	Expired.
MAMA_MSG_STATUS_TIMEOUT	A time out occurred.
MAMA_MSG_STATUS_MISC	Miscellaneous status. Not an error
MAMA_MSG_STATUS_STALE	The subject is stale. Messages may have been dropped
MAMA_MSG_STATUS_TIBRV_STATUS
MAMA_MSG_STATUS_PLATFORM_STATUS	Error in the underlying messaging API.
MAMA_MSG_STATUS_NOT_ENTITLED	Not entitled to a subject.
MAMA_MSG_STATUS_NOT_FOUND	Not found.
MAMA_MSG_STATUS_POSSIBLY_STALE	Messages may have been dropped.
MAMA_MSG_STATUS_NOT_PERMISSIONED	Not permissioned for the subject.
MAMA_MSG_STATUS_TOPIC_CHANGE	Topic renamed.
MAMA_MSG_STATUS_BANDWIDTH_EXCEEDED	Bandwidth exceeded.
MAMA_MSG_STATUS_DUPLICATE	Message with duplicate sequence number.
MAMA_MSG_STATUS_UNKNOWN	Unknown status.

{
    MAMA_MSG_STATUS_OK                  =   0,

    MAMA_MSG_STATUS_LINE_DOWN           =   1,

    MAMA_MSG_STATUS_NO_SUBSCRIBERS      =   2,

    MAMA_MSG_STATUS_BAD_SYMBOL          =   3,

    MAMA_MSG_STATUS_EXPIRED             =   4,

    MAMA_MSG_STATUS_TIMEOUT             =   5,

    MAMA_MSG_STATUS_MISC                =   6,

    MAMA_MSG_STATUS_STALE               =   7,

    MAMA_MSG_STATUS_TIBRV_STATUS        =   8,

    MAMA_MSG_STATUS_PLATFORM_STATUS     =   8,

    MAMA_MSG_STATUS_NOT_ENTITLED        =   9,

    MAMA_MSG_STATUS_NOT_FOUND           =   10,

    MAMA_MSG_STATUS_POSSIBLY_STALE      =   11,

    MAMA_MSG_STATUS_NOT_PERMISSIONED    =   12,

    MAMA_MSG_STATUS_TOPIC_CHANGE        =   13,

    MAMA_MSG_STATUS_BANDWIDTH_EXCEEDED  =   14,

    MAMA_MSG_STATUS_DUPLICATE           =   15,

    MAMA_MSG_STATUS_UNKNOWN             =   99

} mamaMsgStatus;

Function Documentation

mamaMsgStatus_statusForMsg()

MAMAExpDLL mamaMsgStatus mamaMsgStatus_statusForMsg

(

const mamaMsg

msg

)

Extract the status from the supplied message.

Parameters

msg	The message.

mamaMsgStatus_stringForMsg()

MAMAExpDLL const char* mamaMsgStatus_stringForMsg

(

const mamaMsg

msg

)

Return the status as a string given a message.

Returns

The string.

mamaMsgStatus_stringForStatus()

MAMAExpDLL const char* mamaMsgStatus_stringForStatus

(

mamaMsgStatus

type

)

Return a text description of the message's status.

Returns

The description.