OpenMAMA
source.h File Reference
#include "mama/config.h"
#include "mama/status.h"
#include "mama/sourceman.h"
#include "mama/types.h"
#include "mama/quality.h"

Go to the source code of this file.

Typedefs

typedef enum mamaSourceState_ mamaSourceState
 

Enumerations

enum  mamaSourceState_ { MAMA_SOURCE_STATE_OFF = 0, MAMA_SOURCE_STATE_OK = 1, MAMA_SOURCE_STATE_UNKNOWN = 99 }
 

Functions

MAMAExpDLL mama_status mamaSource_create (mamaSource *source)
 Create a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_destroy (mamaSource source)
 Destroy a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_clear (mamaSource source)
 Clear a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_setId (mamaSource source, const char *id)
 Set the ID of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_setMappedId (mamaSource source, const char *id)
 Set the mapped ID of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_setDisplayId (mamaSource source, const char *id)
 Set the display ID of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_setQuality (mamaSource source, mamaQuality quality)
 Set the quality of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_setState (mamaSource source, mamaSourceState quality)
 Set the state of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_setParent (mamaSource source, mamaSource parent)
 Set the parent for a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_setSymbolNamespace (mamaSource source, const char *symbolNamespace)
 Set the publisher specific source name for this source. More...
 
MAMAExpDLL mama_status mamaSource_setTransportName (mamaSource source, const char *transportName)
 Set the name of the mamaTransport on which this describes a valid source of data. More...
 
MAMAExpDLL mama_status mamaSource_setTransport (mamaSource source, mamaTransport transport)
 Associate a mamaTransport object with the source. More...
 
MAMAExpDLL mama_status mamaSource_setSymbology (mamaSource source, mamaSymbology symbology)
 Associate a mamaSymbology object with the source. More...
 
MAMAExpDLL mama_status mamaSource_getId (const mamaSource source, const char **id)
 Get the ID of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_getMappedId (const mamaSource source, const char **id)
 Get the mapped ID of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_getDisplayId (const mamaSource source, const char **id)
 Get the display ID of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_getQuality (const mamaSource source, mamaQuality *quality)
 Get the quality of a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_getState (const mamaSource source, mamaSourceState *state)
 Get the state of a mamaSource object. More...
 
const MAMAExpDLL char * mamaSource_getStateAsString (const mamaSource source)
 
MAMAExpDLL mama_status mamaSource_getParent (const mamaSource source, mamaSource *parent)
 Get the parent source for a mamaSource object. More...
 
MAMAExpDLL mama_status mamaSource_getSymbolNamespace (const mamaSource source, const char **symbolNamespace)
 Get the source name for the publisher which this mamaSource represents. More...
 
MAMAExpDLL mama_status mamaSource_getTransportName (const mamaSource source, const char **transportName)
 Get the name of the mamaTransport on which this source is valid. More...
 
MAMAExpDLL mama_status mamaSource_getTransport (const mamaSource source, mamaTransport *transport)
 Get the mamaTransport associated with this source. More...
 
MAMAExpDLL mama_status mamaSource_getSymbology (const mamaSource source, mamaSymbology *symbology)
 Get the mamaSymbology associated with this source. More...
 
MAMAExpDLL mama_status mamaSource_getSubSourceManager (const mamaSource source, mamaSourceManager *subSourceManager)
 A mamaSource can have sub-sources. More...
 

Typedef Documentation

◆ mamaSourceState

Enumeration Type Documentation

◆ mamaSourceState_

Enumerator
MAMA_SOURCE_STATE_OFF 
MAMA_SOURCE_STATE_OK 
MAMA_SOURCE_STATE_UNKNOWN 

Function Documentation

◆ mamaSource_create()

MAMAExpDLL mama_status mamaSource_create ( mamaSource source)

Create a mamaSource object.

Parameters
sourceThe location of a mamaSource to store the result.

◆ mamaSource_destroy()

MAMAExpDLL mama_status mamaSource_destroy ( mamaSource  source)

Destroy a mamaSource object.

Parameters
sourceThe source object to destroy.

◆ mamaSource_clear()

MAMAExpDLL mama_status mamaSource_clear ( mamaSource  source)

Clear a mamaSource object.

Parameters
sourceThe source object to clear.

◆ mamaSource_setId()

MAMAExpDLL mama_status mamaSource_setId ( mamaSource  source,
const char *  id 
)

Set the ID of a mamaSource object.

Parameters
sourceThe source object to update.
idThe new ID for the source object.

◆ mamaSource_setMappedId()

MAMAExpDLL mama_status mamaSource_setMappedId ( mamaSource  source,
const char *  id 
)

Set the mapped ID of a mamaSource object.

The mapped ID is the ID that the parent source manager has mapped this source as.

Parameters
sourceThe source object to update.
idThe new mapped ID for the source object.

◆ mamaSource_setDisplayId()

MAMAExpDLL mama_status mamaSource_setDisplayId ( mamaSource  source,
const char *  id 
)

Set the display ID of a mamaSource object.

Parameters
sourceThe source object to update.
idThe new display ID for the source object.

◆ mamaSource_setQuality()

MAMAExpDLL mama_status mamaSource_setQuality ( mamaSource  source,
mamaQuality  quality 
)

Set the quality of a mamaSource object.

Parameters
sourceThe source object to update.
qualityThe new quality for the source object.

◆ mamaSource_setState()

MAMAExpDLL mama_status mamaSource_setState ( mamaSource  source,
mamaSourceState  quality 
)

Set the state of a mamaSource object.

Parameters
sourceThe source object to update.
qualityThe new state for the source object.

◆ mamaSource_setParent()

MAMAExpDLL mama_status mamaSource_setParent ( mamaSource  source,
mamaSource  parent 
)

Set the parent for a mamaSource object.

The current mamaSource is added to the parents sub source manager.

See also
mamaSource_getSubSourceManager()
Parameters
sourceThe source object to update.
parentThe parent source for this source object.

◆ mamaSource_setSymbolNamespace()

MAMAExpDLL mama_status mamaSource_setSymbolNamespace ( mamaSource  source,
const char *  symbolNamespace 
)

Set the publisher specific source name for this source.

e.g. This could be "NASDAQ" for a UTP PAPA publisher.

Parameters
sourceThe source object to update.
symbolNamespaceThe namespace for the publisher this mamaSource object describes.

◆ mamaSource_setTransportName()

MAMAExpDLL mama_status mamaSource_setTransportName ( mamaSource  source,
const char *  transportName 
)

Set the name of the mamaTransport on which this describes a valid source of data.

Parameters
sourceThe source object to update.
transportNameThe name of the mamaTransport for which this source is valid.

◆ mamaSource_setTransport()

MAMAExpDLL mama_status mamaSource_setTransport ( mamaSource  source,
mamaTransport  transport 
)

Associate a mamaTransport object with the source.

Parameters
sourceThe source to update.
transportThe mamaTransport to associate with the source.

◆ mamaSource_setSymbology()

MAMAExpDLL mama_status mamaSource_setSymbology ( mamaSource  source,
mamaSymbology  symbology 
)

Associate a mamaSymbology object with the source.

Parameters
sourceThe source to update.
symbologyThe mamaSymbology to associate with the source.

◆ mamaSource_getId()

MAMAExpDLL mama_status mamaSource_getId ( const mamaSource  source,
const char **  id 
)

Get the ID of a mamaSource object.

Parameters
sourceThe source object to check.
idLocation of the result for the ID of the source.

◆ mamaSource_getMappedId()

MAMAExpDLL mama_status mamaSource_getMappedId ( const mamaSource  source,
const char **  id 
)

Get the mapped ID of a mamaSource object.

Parameters
sourceThe source object to check.
idLocation of the result for the mapped ID of the source.

◆ mamaSource_getDisplayId()

MAMAExpDLL mama_status mamaSource_getDisplayId ( const mamaSource  source,
const char **  id 
)

Get the display ID of a mamaSource object.

Parameters
sourceThe source object to check.
idLocation of the result for the display ID of the source.

◆ mamaSource_getQuality()

MAMAExpDLL mama_status mamaSource_getQuality ( const mamaSource  source,
mamaQuality quality 
)

Get the quality of a mamaSource object.

Parameters
sourceThe source object to check.
qualityLocation of the result for the quality of the source.

◆ mamaSource_getState()

MAMAExpDLL mama_status mamaSource_getState ( const mamaSource  source,
mamaSourceState state 
)

Get the state of a mamaSource object.

Parameters
sourceThe source object to check.
stateLocation of the result for the state of the source.

◆ mamaSource_getStateAsString()

const MAMAExpDLL char* mamaSource_getStateAsString ( const mamaSource  source)

◆ mamaSource_getParent()

MAMAExpDLL mama_status mamaSource_getParent ( const mamaSource  source,
mamaSource parent 
)

Get the parent source for a mamaSource object.

Parameters
sourceThe source object to check.
parentLocation to store the address of the parent for this source.

◆ mamaSource_getSymbolNamespace()

MAMAExpDLL mama_status mamaSource_getSymbolNamespace ( const mamaSource  source,
const char **  symbolNamespace 
)

Get the source name for the publisher which this mamaSource represents.

Parameters
sourceThe source object to check.
symbolNamespaceThe source name for the publisher.

◆ mamaSource_getTransportName()

MAMAExpDLL mama_status mamaSource_getTransportName ( const mamaSource  source,
const char **  transportName 
)

Get the name of the mamaTransport on which this source is valid.

Parameters
sourceThe source object to check.
transportNameThe location to store the pointer to the transportName.

◆ mamaSource_getTransport()

MAMAExpDLL mama_status mamaSource_getTransport ( const mamaSource  source,
mamaTransport transport 
)

Get the mamaTransport associated with this source.

Parameters
sourceThe source object to check.
transportThe mamaTransport associated with this source.

◆ mamaSource_getSymbology()

MAMAExpDLL mama_status mamaSource_getSymbology ( const mamaSource  source,
mamaSymbology symbology 
)

Get the mamaSymbology associated with this source.

Parameters
sourceThe source object to check.
symbologyThe mamaSymbology associated with this source.

◆ mamaSource_getSubSourceManager()

MAMAExpDLL mama_status mamaSource_getSubSourceManager ( const mamaSource  source,
mamaSourceManager subSourceManager 
)

A mamaSource can have sub-sources.

These sub sources are maintained by a mamaSourceManager within the mamaSource.

Parameters
sourceThe mamaSource for which the sub source manager is being obtained.
subSourceManagerThe location top store the address of the sub source manager object pointer.
MAMA_SOURCE_STATE_OK
@ MAMA_SOURCE_STATE_OK
Definition: source.h:38
MAMA_SOURCE_STATE_OFF
@ MAMA_SOURCE_STATE_OFF
Definition: source.h:37
mamaSourceState
enum mamaSourceState_ mamaSourceState
MAMA_SOURCE_STATE_UNKNOWN
@ MAMA_SOURCE_STATE_UNKNOWN
Definition: source.h:39


© 2012 Linux Foundation