Wombat::MamaSource

A MamaSource maintains information about a data source, including the quality of the data coming from that source

Inherits from Wombat.MamaWrapper, Wombat.ISourceManager, IDisposable

Public Functions

	Name
	MamaSource() Constructs and creates a new source object. M:Wombat.MamaWrapper.::ctor
void	destroy() Destroy the source. A synonym to the MamaWrapper.Dispose method.
void	clear() Clear the source
MamaSource	create(string name) Implements ISourceManager.create
MamaSource	findOrCreate(string name) Implements ISourceManager.findOrCreate
MamaSource	find(string name) Implements ISourceManager.find
void	add(MamaSource source) Implements ISourceManager.add(MamaSource)
void	add(string name, MamaSource source) Implements [ISourceManager.add(System.String, MamaSource)]

Protected Functions

	Name
virtual override MamaStatus.mamaStatus	DestroyNativePeer() Implements the destruction of the underlying peer object MamaWrapper.DestroyNativePeer

Public Properties

	Name
string	id Gets or sets the ID of the source
string	displayId Gets or sets the display ID of the source
string	mappedId Gets or sets the mapped ID of the source The mapped ID is the ID that parent source mManager has mapped this source as.
mamaQuality	quality Gets or sets the quality of the source
mamaSourceState	state Gets or sets the state of the source
string	stateAsString Get the stringified representation of the source state.
MamaSource	parent Gets or sets the parent for the source. When the parent is set the source is added to the parent source mManager.
string	symbolNamespace Gets or sets the publisher specific source name for this source. E.g. This could be “NASDAQ” for a UTP PAPA publisher.
string	transportName Gets or sets the name of the MamaTransport on which this describes a valid source of
MamaTransport	transport Returns or associates a transport object with the source.

Additional inherited members

Public Functions inherited from Wombat.MamaWrapper

	Name
void	Dispose() Destroys the underlying peer object and unbinds the wrapper from it.
void	setNativeHandle(IntPtr nHandle) Sets the native handle of the native peer object. Should only be used by subclasses and in the same assembly.

Protected Functions inherited from Wombat.MamaWrapper

	Name
	MamaWrapper() Constructs a new wrapper object but doesn’t create it. If the object is not explicitly disposed it will remain registered for finalization and will attempt the destroy the native peer object when finalized.
	MamaWrapper(IntPtr nativeHandle) Constructs a managed wrapper from an existing native peer. The peer object will not be automatically finalized
virtual void	Dispose(bool disposing, bool destroyNativeHandle =true) The actual implementation of Dispose - called by both the Dispose method and the finalizer.
virtual void	OnDispose()

Protected Attributes inherited from Wombat.MamaWrapper

	Name
IntPtr	nativeHandle the handle to the native peer object

Public Functions Documentation

function MamaSource

MamaSource()

Constructs and creates a new source object. M:Wombat.MamaWrapper.::ctor

function destroy

void destroy()

Destroy the source. A synonym to the MamaWrapper.Dispose method.

function clear

void clear()

Clear the source

function create

MamaSource create(
    string name
)

Implements ISourceManager.create

Reimplements: Wombat::ISourceManager::create

function findOrCreate

MamaSource findOrCreate(
    string name
)

Implements ISourceManager.findOrCreate

Reimplements: Wombat::ISourceManager::findOrCreate

function find

MamaSource find(
    string name
)

Implements ISourceManager.find

Reimplements: Wombat::ISourceManager::find

function add

void add(
    MamaSource source
)

Implements ISourceManager.add(MamaSource)

Reimplements: Wombat::ISourceManager::add

function add

void add(
    string name,
    MamaSource source
)

Implements [ISourceManager.add(System.String, MamaSource)]

Reimplements: Wombat::ISourceManager::add

Protected Functions Documentation

function DestroyNativePeer

virtual override MamaStatus.mamaStatus DestroyNativePeer()

Implements the destruction of the underlying peer object MamaWrapper.DestroyNativePeer

Return: MAMA Status code

Reimplements: Wombat::MamaWrapper::DestroyNativePeer

Public Property Documentation

property id

string id;

Gets or sets the ID of the source

property displayId

string displayId;

Gets or sets the display ID of the source

property mappedId

string mappedId;

Gets or sets the mapped ID of the source The mapped ID is the ID that parent source mManager has mapped this source as.

property quality

mamaQuality quality;

Gets or sets the quality of the source

property state

mamaSourceState state;

Gets or sets the state of the source

property stateAsString

string stateAsString;

Get the stringified representation of the source state.

property parent

MamaSource parent;

Gets or sets the parent for the source. When the parent is set the source is added to the parent source mManager.

property symbolNamespace

string symbolNamespace;

Gets or sets the publisher specific source name for this source. E.g. This could be “NASDAQ” for a UTP PAPA publisher.

property transportName

string transportName;

Gets or sets the name of the MamaTransport on which this describes a valid source of

property transport

MamaTransport transport;

Returns or associates a transport object with the source.

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