OpenMAMA
servicelevel.h File Reference
#include "mama/types.h"

Go to the source code of this file.

Typedefs

typedef enum mamaServiceLevel_ mamaServiceLevel
 mamaServiceLevel is an enumeration that represents the service level (a) requested by a subscribing application, or (b) provided by the publisher. More...
 

Enumerations

enum  mamaServiceLevel_ {
  MAMA_SERVICE_LEVEL_REAL_TIME = 0, MAMA_SERVICE_LEVEL_SNAPSHOT = 1, MAMA_SERVICE_LEVEL_REPEATING_SNAPSHOT = 2, MAMA_SERVICE_LEVEL_CONFLATED = 5,
  MAMA_SERVICE_LEVEL_UNKNOWN = 99
}
 mamaServiceLevel is an enumeration that represents the service level (a) requested by a subscribing application, or (b) provided by the publisher. More...
 

Functions

MAMAExpDLL mamaServiceLevel mamaServiceLevel_getFromMsg (const mamaMsg msg)
 Extract the subscription service level from a message. More...
 
const MAMAExpDLL char * mamaServiceLevel_getFromMsgAsString (const mamaMsg msg)
 Extract the subscription service level as a string from a message. More...
 
const MAMAExpDLL char * mamaServiceLevel_toString (mamaServiceLevel type)
 Convert a mamaServiceLevel to a string. More...
 

Typedef Documentation

◆ mamaServiceLevel

mamaServiceLevel is an enumeration that represents the service level (a) requested by a subscribing application, or (b) provided by the publisher.

In the future, the service level provided to the application might change dynamically, depending upon infrastructure capacity. So, even though the requested service level is "real time", if service deteriorates for any reason, the subscription may automatically switch to a conflated level (after notifying the application of the switch).

Enumeration Type Documentation

◆ mamaServiceLevel_

mamaServiceLevel is an enumeration that represents the service level (a) requested by a subscribing application, or (b) provided by the publisher.

In the future, the service level provided to the application might change dynamically, depending upon infrastructure capacity. So, even though the requested service level is "real time", if service deteriorates for any reason, the subscription may automatically switch to a conflated level (after notifying the application of the switch).

Enumerator
MAMA_SERVICE_LEVEL_REAL_TIME 

Real time updates.

MAMA_SERVICE_LEVEL_SNAPSHOT 

Single snapshot image only.

MAMA_SERVICE_LEVEL_REPEATING_SNAPSHOT 

Repeating snapshot image.

When creating subscriptions, the serviceLevelOpt parameter should be set to the number of milliseconds representing the interval between snapshots. The first snapshot will be obtained within some random period between zero and the interval. Only one snapshot request will be allowed to be outstanding at a time.

MAMA_SERVICE_LEVEL_CONFLATED 

Conflated updates (future).

MAMA_SERVICE_LEVEL_UNKNOWN 

Unknown level.

Function Documentation

◆ mamaServiceLevel_getFromMsg()

MAMAExpDLL mamaServiceLevel mamaServiceLevel_getFromMsg ( const mamaMsg  msg)

Extract the subscription service level from a message.

Parameters
msgThe message.

◆ mamaServiceLevel_getFromMsgAsString()

const MAMAExpDLL char* mamaServiceLevel_getFromMsgAsString ( const mamaMsg  msg)

Extract the subscription service level as a string from a message.

Parameters
msgThe message.

◆ mamaServiceLevel_toString()

const MAMAExpDLL char* mamaServiceLevel_toString ( mamaServiceLevel  type)

Convert a mamaServiceLevel to a string.

Parameters
typeThe mamaServiceLevel.
MAMA_SERVICE_LEVEL_REAL_TIME
@ MAMA_SERVICE_LEVEL_REAL_TIME
Real time updates.
Definition: servicelevel.h:51
MAMA_SERVICE_LEVEL_SNAPSHOT
@ MAMA_SERVICE_LEVEL_SNAPSHOT
Single snapshot image only.
Definition: servicelevel.h:56
mamaServiceLevel
enum mamaServiceLevel_ mamaServiceLevel
mamaServiceLevel is an enumeration that represents the service level (a) requested by a subscribing a...
MAMA_SERVICE_LEVEL_CONFLATED
@ MAMA_SERVICE_LEVEL_CONFLATED
Conflated updates (future).
Definition: servicelevel.h:71
MAMA_SERVICE_LEVEL_UNKNOWN
@ MAMA_SERVICE_LEVEL_UNKNOWN
Unknown level.
Definition: servicelevel.h:76
MAMA_SERVICE_LEVEL_REPEATING_SNAPSHOT
@ MAMA_SERVICE_LEVEL_REPEATING_SNAPSHOT
Repeating snapshot image.
Definition: servicelevel.h:66


© 2012 Linux Foundation