com::wombat::mama::MamaThrottleInstance

More…

Public Functions

Public Attributes

Detailed Description

class com::wombat::mama::MamaThrottleInstance;

This class provides an enumeration of types and methods for MAMA throttle instance. Used with setOutboundThrottle and getOutboundThrottle in the JNI version of the API.

Enum to determine into which throttle a call applies. Currently the default throttle, used by the publisher, and the initial value request throttle are the same. Mama sends recap requests on a separate throttle.

Public Functions Documentation

function toString

inline String toString()

Return: Name for the type.

Returns the stringified name for the enumerated type.

function getValue

inline int getValue()

Return: The integer type.

Returns the integer value for the type. This value can be used in switch statements against the public XXX_VALUE static members of the class.

function equals

inline boolean equals(
    MamaThrottleInstance throttleInstance
)

Parameters:

• throttleInstance The object to check equality against.

Return: Whether the two objects are equal.

Compare the two types for equality. Returns true if the integer value of both types is equal. Otherwise returns false.

function valueToString

static inline String valueToString(
    int value
)

Parameters:

• value The int value for a MamaThrottleInstance.

Return: The string name value of the specified MamaThrottleInstance integer value.

Utility method for mapping type integer values to corresponding string values.

Returns “UNKNOWN” is the int type value is not recognised.

function enumObjectForValue

static inline MamaThrottleInstance enumObjectForValue(
    int value
)

Parameters:

• value Int value for a MamaThrottleInstance.

Return: Instance of a MamaThrottleInstance if a mapping exists.

Return an instance of a MamaMdMsgType corresponding to the specified integer value. Returns null if the integer value is not recognised.

Public Attributes Documentation

variable DEFAULT_THROTTLE_VALUE

static final int DEFAULT_THROTTLE_VALUE = 0;

The default throttle queue

variable DEFAULT_THROTTLE

static final MamaThrottleInstance DEFAULT_THROTTLE = 
            new MamaThrottleInstance (valueToString (DEFAULT_THROTTLE_VALUE), 
                                      DEFAULT_THROTTLE_VALUE);

variable INITIAL_THROTTLE_VALUE

static final int INITIAL_THROTTLE_VALUE = 1;

The initial value throttle queue

variable INITIAL_THROTTLE

static final MamaThrottleInstance INITIAL_THROTTLE = 
            new MamaThrottleInstance (valueToString (INITIAL_THROTTLE_VALUE), 
                                      INITIAL_THROTTLE_VALUE);

variable RECAP_THROTTLE_VALUE

static final int RECAP_THROTTLE_VALUE = 2;

The recap throttle queue

variable RECAP_THROTTLE

static final MamaThrottleInstance RECAP_THROTTLE = 
            new MamaThrottleInstance (valueToString (RECAP_THROTTLE_VALUE), 
                                      RECAP_THROTTLE_VALUE);

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