Classes Files

com::wombat::mama::MamaMsgStatus

More…

Public Functions

  Name
int statusForMsg(final MamaMsg msg)
String stringForStatus(final MamaMsg msg)
String stringForStatus(final int type)

Public Attributes

  Name
final short STATUS_OK
final short STATUS_LINE_DOWN
final short STATUS_NO_SUBSCRIBERS
final short STATUS_BAD_SYMBOL
final short STATUS_EXPIRED
final short STATUS_TIMEOUT
final short STATUS_MISC
final short STATUS_STALE
final short STATUS_TIBRV_STATUS
final short STATUS_PLATFORM_STATUS
final short STATUS_NOT_ENTITLED
final short STATUS_NOT_FOUND
final short STATUS_POSSIBLY_STALE
final short STATUS_NOT_PERMISSIONED
final short STATUS_TOPIC_CHANGE
final short STATUS_BANDWIDTH_EXCEEDED
final short STATUS_DUPLICATE
final short STATUS_DELETE
final short STATUS_EXCEPTION

Detailed Description

class com::wombat::mama::MamaMsgStatus;

Utility class for interpreting Mama message status.

Public Functions Documentation

function statusForMsg

static inline int statusForMsg(
    final MamaMsg msg
)

Parameters:

  • msg

Extract the status from the supplied message.

function stringForStatus

static inline String stringForStatus(
    final MamaMsg msg
)

Return: The string.

Return the status as a string given an [MamaMsg](classcom_1_1wombat_1_1mama_1_1MamaMsg.html) message.

function stringForStatus

static inline String stringForStatus(
    final int type
)

Return: The description.

Return a text description of the message’s status.

Public Attributes Documentation

variable STATUS_OK

static final short STATUS_OK = 0;

OK

variable STATUS_LINE_DOWN

static final short STATUS_LINE_DOWN = 1;

The feed handler has detected a Line Down.

variable STATUS_NO_SUBSCRIBERS

static final short STATUS_NO_SUBSCRIBERS = 2;

The feed handler does not have any subscribers to the subject

variable STATUS_BAD_SYMBOL

static final short STATUS_BAD_SYMBOL = 3;

The symbol does not exist

variable STATUS_EXPIRED

static final short STATUS_EXPIRED = 4;

Expired

variable STATUS_TIMEOUT

static final short STATUS_TIMEOUT = 5;

A time out occurred

variable STATUS_MISC

static final short STATUS_MISC = 6;

Miscellaneous status. Not an error

variable STATUS_STALE

static final short STATUS_STALE = 7;

The subject is stale. Messages may have been dropped

variable STATUS_TIBRV_STATUS

static final short STATUS_TIBRV_STATUS = 8;

variable STATUS_PLATFORM_STATUS

static final short STATUS_PLATFORM_STATUS = 8;

Error in the underlying messaging API

variable STATUS_NOT_ENTITLED

static final short STATUS_NOT_ENTITLED = 9;

Not entitled to a subject

variable STATUS_NOT_FOUND

static final short STATUS_NOT_FOUND = 10;

Not found

variable STATUS_POSSIBLY_STALE

static final short STATUS_POSSIBLY_STALE = 11;

Messages may have been dropped

variable STATUS_NOT_PERMISSIONED

static final short STATUS_NOT_PERMISSIONED = 12;

Not permissioned for the subject

variable STATUS_TOPIC_CHANGE

static final short STATUS_TOPIC_CHANGE = 13;

Topic renamed

variable STATUS_BANDWIDTH_EXCEEDED

static final short STATUS_BANDWIDTH_EXCEEDED = 14;

Bandwidth exceeded

variable STATUS_DUPLICATE

static final short STATUS_DUPLICATE = 15;

Message with duplicate sequence number

variable STATUS_DELETE

static final short STATUS_DELETE = 17;

Message with the type of DELETE

variable STATUS_EXCEPTION

static final short STATUS_EXCEPTION = 999;

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