com::wombat::mama::MamaSource

Inherits from com.wombat.mama.MamaSourceManager

Inherited by com.wombat.mama.MamaSourceDerivative

Public Functions

	Name
	MamaSource()
	MamaSource(final String sourceId, MamaTransport transport, final String symbolNamespace)
native void	setId(final String sourceId)
native void	setMappedId(final String mappedId)
native void	setDisplayId(final String displayId)
native void	setQuality(short quality)
void	setState(MamaSourceState state)
void	setParent(MamaSource parent)
native void	setSymbolNamespace(final String symbolNamespace)
void	setTransportName(final String transportName)
void	setTransport(MamaTransport transport)
native final String	getId()
native final String	getMappedId()
native final String	getDisplayId()
native short	getQuality()
MamaSourceState	getState()
String	getStateAsString()
MamaSource	getParent()
native final String	getSymbolNamespace()
MamaTransport	getTransport()
void	addSubscription(final String key, MamaSubscription subscription)
MamaSubscription	findSubscription(final String key)
boolean	isPartOf(MamaSource source)
void	destroy()

Additional inherited members

Public Functions inherited from com.wombat.mama.MamaSourceManager

	Name
	MamaSourceManager()
MamaSource	findOrCreateSource(final String sourceName)
MamaSource	findSource(final String sourceName)
void	addSource(MamaSource mamaSource)
void	addSource(MamaSource mamaSource, final String sourceName)
int	getSize()
Iterator	sourceIterator()

Detailed Description

class com::wombat::mama::MamaSource;

A MAMA source maintains information about a data source, including the quality of the data coming from that source. It inherits MamaSourceManager because a source can have sub-sources.

Public Functions Documentation

function MamaSource

inline MamaSource()

Creates a new mama source with default parameters

function MamaSource

inline MamaSource(
    final String sourceId,
    MamaTransport transport,
    final String symbolNamespace
)

function setId

native void setId(
    final String sourceId
)

function setMappedId

native void setMappedId(
    final String mappedId
)

function setDisplayId

native void setDisplayId(
    final String displayId
)

function setQuality

native void setQuality(
    short quality
)

function setState

inline void setState(
    MamaSourceState state
)

function setParent

inline void setParent(
    MamaSource parent
)

function setSymbolNamespace

native void setSymbolNamespace(
    final String symbolNamespace
)

function setTransportName

inline void setTransportName(
    final String transportName
)

function setTransport

inline void setTransport(
    MamaTransport transport
)

function getId

native final String getId()

function getMappedId

native final String getMappedId()

function getDisplayId

native final String getDisplayId()

function getQuality

native short getQuality()

Reimplemented by: com::wombat::mama::MamaSourceDerivative::getQuality

function getState

inline MamaSourceState getState()

Return: The state of the source object

Reimplemented by: com::wombat::mama::MamaSourceDerivative::getState

Get the state of a mama source object

function getStateAsString

inline String getStateAsString()

Return: The stringified state of the source object

Get the stringified state name of a mama source object

function getParent

inline MamaSource getParent()

Return: MamaSource parent object

Get the parent source of the mama source object

function getSymbolNamespace

native final String getSymbolNamespace()

function getTransport

inline MamaTransport getTransport()

function addSubscription

inline void addSubscription(
    final String key,
    MamaSubscription subscription
)

Parameters:

key Key value to use to insert Subscription into a Subscription Map
subscription MamaSubscription object

Exceptions:

MamaException will be thrown is the key value already exists in the Map

Add a subscriptions to the mamaSource

function findSubscription

inline MamaSubscription findSubscription(
    final String key
)

Parameters:

key The String identifier key for the subscription

Return: The mama subscription object

find a MamaSubscription, null will be returned if not found

function isPartOf

inline boolean isPartOf(
    MamaSource source
)

function destroy

inline void destroy()

Reimplements: com::wombat::mama::MamaSourceManager::destroy

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