C# Class Wombat.MamaTransport

The underpinning object in any MAMA application

The mamaTransport defines the network protocol level parameters over which MAMA distributes data. Transports effectively provide scope for data identifying the underlying protocols and their values for data delivery. It is an isolated communication channel for data traffic. Transports specify the communication channels to use for making subscriptions and publishing data through the API.

Inheritance: MamaWrapper

Afficher le fichier Open project: OpenMAMA/OpenMAMA Class Usage Examples

Méthodes publiques

Méthode	Description
MamaTransport ( ) : System	Allocate a transport structure. You need to call destroy() when the class is no more needed The transport is not created until create() is called. Any transport properties should be set prior to calling create()
create ( string name, Wombat.MamaBridge bridgeImpl ) : void	Create a previously allocated transport. Platform specific parameters are read from the properties file mama.properties. The properties file is located in the WOMBAT_PATH directory. The parameters are dependent on the underlying messaging transport. TIBRV transports support the following: mama.tibrv.transport.name.service, mama.tibrv.transport.name.network, and mama.tibrv.transport.name.daemon. These correspond to the parameters for tibrvTransport_Create(). LBM: See the example mama.properties supplied with the release.
destroy ( ) : void
getName ( ) : string	Get the name of the transport.
getNativeTransport ( ) : IntPtr
getOutboundThrottle ( MamaThrottleInstance instance ) : double	Get the outbound throttle rate. This the rate at which the transport sends outbound messages to the feed handlers. It is also the rate at which new subscriptions are created. Its purpose is to avoid flooding the network with requests.
getSymbolMapFunc ( ) : MamaSymbolMapCallback	Return the symbol mapping function for a MamaTransport.
getSymbolMapFuncClosure ( ) : object	Return the symbol mapping function closure for a MamaTransport.
getTransportCallbackQueue ( ) : Wombat.MamaQueue	Set a queue for transport callbacks (transport and topic). If this is not set the default queue will be used.
requestConflation ( ) : void	Request conflation for a MamaTransport. Currently only available for WMW.
requestEndConflation ( ) : void	Request an end to conflation for a MamaTransport. Currently only available for WMW.
setOutboundThrottle ( MamaThrottleInstance instance, double outboundThrottle ) : void	Set the throttle rate.
setSymbolMapFunc ( MamaSymbolMapCallback callback, object closure ) : void	Set the symbol mapping function for a MamaTransport.
setTransportCallback ( MamaTransportCallback callback ) : void	Set the transport callback. It receives advisories when a transport disconnects or reconnects. Passing NULL removes the callback.
setTransportCallbackQueue ( Wombat.MamaQueue queue ) : void	Set a queue for transport callbacks (transport and topic). If this is not set the default queue will be used.
setTransportTopicCallback ( MamaTransportTopicCallback callback ) : void	Set the transport topic callback. It receives advisories when subjects sub or unsub, or when publisher events occur. Passing NULL removes the callback.

Méthodes protégées

Méthode	Description
DestroyNativePeer ( ) : MamaStatus.mamaStatus	Implements the destruction of the underlying peer object MamaWrapper.DestroyNativePeer
OnDispose ( ) : void

Private Methods

Méthode	Description
MamaTransport ( IntPtr transport ) : System

Method Details

DestroyNativePeer() protected méthode

Implements the destruction of the underlying peer object MamaWrapper.DestroyNativePeer

protected DestroyNativePeer ( ) : MamaStatus.mamaStatus
Résultat	MamaStatus.mamaStatus

MamaTransport() public méthode

Allocate a transport structure. You need to call destroy() when the class is no more needed The transport is not created until create() is called. Any transport properties should be set prior to calling create()

public MamaTransport ( ) : System
Résultat	System

OnDispose() protected méthode

protected OnDispose ( ) : void
Résultat	void

create() public méthode

Create a previously allocated transport. Platform specific parameters are read from the properties file mama.properties. The properties file is located in the WOMBAT_PATH directory. The parameters are dependent on the underlying messaging transport. TIBRV transports support the following: mama.tibrv.transport.name.service, mama.tibrv.transport.name.network, and mama.tibrv.transport.name.daemon. These correspond to the parameters for tibrvTransport_Create(). LBM: See the example mama.properties supplied with the release.

public create ( string name, Wombat.MamaBridge bridgeImpl ) : void
name	string
bridgeImpl	Wombat.MamaBridge
Résultat	void

destroy() public méthode

public destroy ( ) : void
Résultat	void

getName() public méthode

Get the name of the transport.

public getName ( ) : string
Résultat	string

getNativeTransport() public méthode

public getNativeTransport ( ) : IntPtr
Résultat	System.IntPtr

getOutboundThrottle() public méthode

Get the outbound throttle rate. This the rate at which the transport sends outbound messages to the feed handlers. It is also the rate at which new subscriptions are created. Its purpose is to avoid flooding the network with requests.

public getOutboundThrottle ( MamaThrottleInstance instance ) : double
instance	MamaThrottleInstance
Résultat	double

getSymbolMapFunc() public méthode

Return the symbol mapping function for a MamaTransport.

public getSymbolMapFunc ( ) : MamaSymbolMapCallback
Résultat	MamaSymbolMapCallback

getSymbolMapFuncClosure() public méthode

Return the symbol mapping function closure for a MamaTransport.

public getSymbolMapFuncClosure ( ) : object
Résultat	object

getTransportCallbackQueue() public méthode

Set a queue for transport callbacks (transport and topic). If this is not set the default queue will be used.

public getTransportCallbackQueue ( ) : Wombat.MamaQueue
Résultat	Wombat.MamaQueue

requestConflation() public méthode

Request conflation for a MamaTransport. Currently only available for WMW.

public requestConflation ( ) : void
Résultat	void

requestEndConflation() public méthode

Request an end to conflation for a MamaTransport. Currently only available for WMW.

public requestEndConflation ( ) : void
Résultat	void

setOutboundThrottle() public méthode

Set the throttle rate.

public setOutboundThrottle ( MamaThrottleInstance instance, double outboundThrottle ) : void
instance	MamaThrottleInstance
outboundThrottle	double
Résultat	void

setSymbolMapFunc() public méthode

Set the symbol mapping function for a MamaTransport.

public setSymbolMapFunc ( MamaSymbolMapCallback callback, object closure ) : void
callback	MamaSymbolMapCallback
closure	object
Résultat	void

setTransportCallback() public méthode

Set the transport callback. It receives advisories when a transport disconnects or reconnects. Passing NULL removes the callback.

public setTransportCallback ( MamaTransportCallback callback ) : void
callback	MamaTransportCallback
Résultat	void

setTransportCallbackQueue() public méthode

Set a queue for transport callbacks (transport and topic). If this is not set the default queue will be used.

public setTransportCallbackQueue ( Wombat.MamaQueue queue ) : void
queue	Wombat.MamaQueue
Résultat	void

setTransportTopicCallback() public méthode

Set the transport topic callback. It receives advisories when subjects sub or unsub, or when publisher events occur. Passing NULL removes the callback.

public setTransportTopicCallback ( MamaTransportTopicCallback callback ) : void
callback	MamaTransportTopicCallback
Résultat	void