OpenMAMA
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...
 
const MAMAExpDLL char * mamaMsgStatus_stringForMsg (const mamaMsg msg)
 Return the status as a string given a message. More...
 
const MAMAExpDLL char * mamaMsgStatus_stringForStatus (mamaMsgStatus type)
 Return a text description of the message's status. More...
 

Typedef Documentation

◆ mamaMsgStatus

Utility class (enum) for interpreting message status.

Enumeration Type Documentation

◆ 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.

Function Documentation

◆ mamaMsgStatus_statusForMsg()

MAMAExpDLL mamaMsgStatus mamaMsgStatus_statusForMsg ( const mamaMsg  msg)

Extract the status from the supplied message.

Parameters
msgThe message.

◆ mamaMsgStatus_stringForMsg()

const MAMAExpDLL char* mamaMsgStatus_stringForMsg ( const mamaMsg  msg)

Return the status as a string given a message.

Returns
The string.

◆ mamaMsgStatus_stringForStatus()

const MAMAExpDLL char* mamaMsgStatus_stringForStatus ( mamaMsgStatus  type)

Return a text description of the message's status.

Returns
The description.
MAMA_MSG_STATUS_PLATFORM_STATUS
@ MAMA_MSG_STATUS_PLATFORM_STATUS
Error in the underlying messaging API.
Definition: msgstatus.h:64
MAMA_MSG_STATUS_EXPIRED
@ MAMA_MSG_STATUS_EXPIRED
Expired.
Definition: msgstatus.h:50
MAMA_MSG_STATUS_TIMEOUT
@ MAMA_MSG_STATUS_TIMEOUT
A time out occurred.
Definition: msgstatus.h:53
MAMA_MSG_STATUS_BAD_SYMBOL
@ MAMA_MSG_STATUS_BAD_SYMBOL
The symbol does not exist.
Definition: msgstatus.h:47
MAMA_MSG_STATUS_TIBRV_STATUS
@ MAMA_MSG_STATUS_TIBRV_STATUS
Definition: msgstatus.h:61
MAMA_MSG_STATUS_POSSIBLY_STALE
@ MAMA_MSG_STATUS_POSSIBLY_STALE
Messages may have been dropped.
Definition: msgstatus.h:73
MAMA_MSG_STATUS_OK
@ MAMA_MSG_STATUS_OK
OK.
Definition: msgstatus.h:38
MAMA_MSG_STATUS_NO_SUBSCRIBERS
@ MAMA_MSG_STATUS_NO_SUBSCRIBERS
The feed handler does not have any subscribers to the subject.
Definition: msgstatus.h:44
MAMA_MSG_STATUS_DUPLICATE
@ MAMA_MSG_STATUS_DUPLICATE
Message with duplicate sequence number.
Definition: msgstatus.h:85
MAMA_MSG_STATUS_LINE_DOWN
@ MAMA_MSG_STATUS_LINE_DOWN
The feed handler has detected a Line Down.
Definition: msgstatus.h:41
MAMA_MSG_STATUS_STALE
@ MAMA_MSG_STATUS_STALE
The subject is stale.
Definition: msgstatus.h:59
MAMA_MSG_STATUS_NOT_PERMISSIONED
@ MAMA_MSG_STATUS_NOT_PERMISSIONED
Not permissioned for the subject.
Definition: msgstatus.h:76
MAMA_MSG_STATUS_TOPIC_CHANGE
@ MAMA_MSG_STATUS_TOPIC_CHANGE
Topic renamed.
Definition: msgstatus.h:79
MAMA_MSG_STATUS_UNKNOWN
@ MAMA_MSG_STATUS_UNKNOWN
Unknown status.
Definition: msgstatus.h:88
MAMA_MSG_STATUS_NOT_FOUND
@ MAMA_MSG_STATUS_NOT_FOUND
Not found.
Definition: msgstatus.h:70
MAMA_MSG_STATUS_NOT_ENTITLED
@ MAMA_MSG_STATUS_NOT_ENTITLED
Not entitled to a subject.
Definition: msgstatus.h:67
MAMA_MSG_STATUS_BANDWIDTH_EXCEEDED
@ MAMA_MSG_STATUS_BANDWIDTH_EXCEEDED
Bandwidth exceeded.
Definition: msgstatus.h:82
MAMA_MSG_STATUS_MISC
@ MAMA_MSG_STATUS_MISC
Miscellaneous status.
Definition: msgstatus.h:56
mamaMsgStatus
enum mamaMsgStatus_ mamaMsgStatus
Utility class (enum) for interpreting message status.


© 2012 Linux Foundation