Apama.Engine.EngineConnection Class Reference

EngineConnection encapsulates the information related to a connection between two Apama messaging components. More...

Public Member Functions
	EngineConnection (string host, int port, string[] channels)
	A constructor for EngineConnection objects. More...
	EngineConnection (string host, int port, bool disconnectSlow, EngineManagement.ConnectMode connectMode, string[] channels)
	A constructor for EngineConnection objects. More...
override string	ToString ()
	A string representation for diagnostics; may change in a future release. More...

Properties
virtual ReadOnlyCollection < string >	Channels [get]
	The channels associated with this connection. More...
virtual EngineManagement.ConnectMode	ConnectMode [get]
	The connection mode associated with this connection More...
virtual bool	DisconnectSlow [get]
	Get the value of disconnectSlow flag associated with this connection More...
virtual string	Host [get]
	The host associated with this connection. More...
virtual int	Port [get]
	The port associated with this connection. More...

Detailed Description

EngineConnection encapsulates the information related to a connection between two Apama messaging components.

Constructor & Destructor Documentation

Apama.Engine.EngineConnection.EngineConnection	(	string	host,
		int	port,
		string[]	channels
	)

A constructor for EngineConnection objects.

Parameters

host	The remote host to connect to
port	The remote port to connect to
channels	The array of channels to connect to. May include the empty String to indicate the default channel. Must be non-null, and contain no null elements.

Apama.Engine.EngineConnection.EngineConnection	(	string	host,
		int	port,
		bool	disconnectSlow,
		EngineManagement.ConnectMode	connectMode,
		string[]	channels
	)

A constructor for EngineConnection objects.

Parameters

host	The remote host to connect to
port	The remote port to connect to
disconnectSlow	Whether we should be disconnected if we don't keep up.
connectMode	The connection mode to use. Set to CONNECT_LEGACY for single connection, all events delivered to the default channel. Set to CONNECT_PARALLEL for connection per channel and channel values passed through.
channels	The array of channels to connect to. May include the empty String to indicate the default channel. Must be non-null, and contain no null elements.

Member Function Documentation

override string Apama.Engine.EngineConnection.ToString

(

)

A string representation for diagnostics; may change in a future release.

Property Documentation

virtual ReadOnlyCollection<string> Apama.Engine.EngineConnection.Channels

get

The channels associated with this connection.

The list of channels that the downstream component should listen to.

virtual EngineManagement.ConnectMode Apama.Engine.EngineConnection.ConnectMode

get

The connection mode associated with this connection

The connection mode for the upstream (even-sending) component

virtual bool Apama.Engine.EngineConnection.DisconnectSlow

get

Get the value of disconnectSlow flag associated with this connection

True if we should be disconnected if this connection is slow

virtual string Apama.Engine.EngineConnection.Host

get

The host associated with this connection.

The host of the upstream (even-sending) component

virtual int Apama.Engine.EngineConnection.Port

get

The port associated with this connection.

The port of the upstream (even-sending) component