#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 enum mamaSourceState_ mamaSourceState |
enum mamaSourceState_ |
MAMAExpDLL mama_status mamaSource_create | ( | mamaSource * | source | ) |
Create a mamaSource object.
source | The location of a mamaSource to store the result. |
MAMAExpDLL mama_status mamaSource_destroy | ( | mamaSource | source | ) |
Destroy a mamaSource object.
source | The source object to destroy. |
MAMAExpDLL mama_status mamaSource_clear | ( | mamaSource | source | ) |
Clear a mamaSource object.
source | The source object to clear. |
MAMAExpDLL mama_status mamaSource_setId | ( | mamaSource | source, |
const char * | id | ||
) |
Set the ID of a mamaSource object.
source | The source object to update. |
id | The new ID for the source object. |
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.
source | The source object to update. |
id | The new mapped ID for the source object. |
MAMAExpDLL mama_status mamaSource_setDisplayId | ( | mamaSource | source, |
const char * | id | ||
) |
Set the display ID of a mamaSource object.
source | The source object to update. |
id | The new display ID for the source object. |
MAMAExpDLL mama_status mamaSource_setQuality | ( | mamaSource | source, |
mamaQuality | quality | ||
) |
Set the quality of a mamaSource object.
source | The source object to update. |
quality | The new quality for the source object. |
MAMAExpDLL mama_status mamaSource_setState | ( | mamaSource | source, |
mamaSourceState | quality | ||
) |
Set the state of a mamaSource object.
source | The source object to update. |
quality | The new state for the source object. |
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.
source | The source object to update. |
parent | The parent source for this source object. |
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.
source | The source object to update. |
symbolNamespace | The namespace for the publisher this mamaSource object describes. |
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.
source | The source object to update. |
transportName | The name of the mamaTransport for which this source is valid. |
MAMAExpDLL mama_status mamaSource_setTransport | ( | mamaSource | source, |
mamaTransport | transport | ||
) |
Associate a mamaTransport object with the source.
source | The source to update. |
transport | The mamaTransport to associate with the source. |
MAMAExpDLL mama_status mamaSource_setSymbology | ( | mamaSource | source, |
mamaSymbology | symbology | ||
) |
Associate a mamaSymbology object with the source.
source | The source to update. |
symbology | The mamaSymbology to associate with the source. |
MAMAExpDLL mama_status mamaSource_getId | ( | const mamaSource | source, |
const char ** | id | ||
) |
Get the ID of a mamaSource object.
source | The source object to check. |
id | Location of the result for the ID of the source. |
MAMAExpDLL mama_status mamaSource_getMappedId | ( | const mamaSource | source, |
const char ** | id | ||
) |
Get the mapped ID of a mamaSource object.
source | The source object to check. |
id | Location of the result for the mapped ID of the source. |
MAMAExpDLL mama_status mamaSource_getDisplayId | ( | const mamaSource | source, |
const char ** | id | ||
) |
Get the display ID of a mamaSource object.
source | The source object to check. |
id | Location of the result for the display ID of the source. |
MAMAExpDLL mama_status mamaSource_getQuality | ( | const mamaSource | source, |
mamaQuality * | quality | ||
) |
Get the quality of a mamaSource object.
source | The source object to check. |
quality | Location of the result for the quality of the source. |
MAMAExpDLL mama_status mamaSource_getState | ( | const mamaSource | source, |
mamaSourceState * | state | ||
) |
Get the state of a mamaSource object.
source | The source object to check. |
state | Location of the result for the state of the source. |
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.
source | The source object to check. |
parent | Location to store the address of the parent for this source. |
MAMAExpDLL mama_status mamaSource_getSymbolNamespace | ( | const mamaSource | source, |
const char ** | symbolNamespace | ||
) |
Get the source name for the publisher which this mamaSource represents.
source | The source object to check. |
symbolNamespace | The source name for the publisher. |
MAMAExpDLL mama_status mamaSource_getTransportName | ( | const mamaSource | source, |
const char ** | transportName | ||
) |
Get the name of the mamaTransport on which this source is valid.
source | The source object to check. |
transportName | The location to store the pointer to the transportName. |
MAMAExpDLL mama_status mamaSource_getTransport | ( | const mamaSource | source, |
mamaTransport * | transport | ||
) |
Get the mamaTransport associated with this source.
source | The source object to check. |
transport | The mamaTransport associated with this source. |
MAMAExpDLL mama_status mamaSource_getSymbology | ( | const mamaSource | source, |
mamaSymbology * | symbology | ||
) |
Get the mamaSymbology associated with this source.
source | The source object to check. |
symbology | The mamaSymbology associated with this source. |
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.
source | The mamaSource for which the sub source manager is being obtained. |
subSourceManager | The location top store the address of the sub source manager object pointer. |