IConnectOperations is an interface that specifies methods for connecting an engine as a consumer of another engine.
More...
Inherited by Apama.Engine.Client.IEngineClient.
|
void | AttachAsConsumerOfEngine (IMessagingClient sourceEngine, string[] channels) |
| Connect this engine to another (non-persisently) so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command.
More...
|
|
void | AttachAsConsumerOfEngine (string sourceHost, int sourcePort, string[] channels) |
| Connect this engine to another (non-persistently) so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command. More...
|
|
void | AttachAsConsumerOfEngine (string sourceHost, int sourcePort, string[] channels, bool persistent) |
| Connect this engine to another so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command. More...
|
|
void | AttachAsConsumerOfEngine (string sourceHost, int sourcePort, string[] channels, bool persistent, bool disconnectSlow, EngineManagement.ConnectMode mode) |
| Connect this engine to another so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command. More...
|
|
void | DetachAsConsumerOfEngine (IMessagingClient sourceEngine, string[] channels) |
| Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the More...
|
|
void | DetachAsConsumerOfEngine (string sourceHost, int sourcePort, string[] channels) |
| Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the More...
|
|
void | DetachAsConsumerOfEngine (string sourceHost, int sourcePort, string[] channels, bool persistent) |
| Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the More...
|
|
void | DetachAsConsumerOfEngine (string sourceHost, int sourcePort, string[] channels, bool persistent, EngineManagement.ConnectMode mode) |
| Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the More...
|
|
EngineConnection[] | GetReceiverConnections () |
| Get all the persistent connections associated with the engine. More...
|
|
void | SetReceiverConnections (params EngineConnection[] connections) |
| Attaches this component as a persistent receiver of the remote components specified in the connections argument, then decrements the reference count of any existing connections (which typically results in their removal). More...
|
|
IConnectOperations is an interface that specifies methods for connecting an engine as a consumer of another engine.
See Apama.Engine.Client.EngineClientConstants for constants used by this interface.
void Apama.Engine.Client.IConnectOperations.AttachAsConsumerOfEngine |
( |
IMessagingClient |
sourceEngine, |
|
|
string[] |
channels |
|
) |
| |
Connect this engine to another (non-persisently) so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command.
Note: If you do not already have a connected EngineClient instance for the source engine, it is usually more efficient to call the overloaded IConnectOperations::attachAsConsumerOfEngine(String, int, String[]) method which takes a source host and port instead.
- Parameters
-
sourceEngine | The EngineClient instance for the engine to receive from. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
- Exceptions
-
void Apama.Engine.Client.IConnectOperations.AttachAsConsumerOfEngine |
( |
string |
sourceHost, |
|
|
int |
sourcePort, |
|
|
string[] |
channels |
|
) |
| |
Connect this engine to another (non-persistently) so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command.
- Parameters
-
sourceHost | The host of the engine to receive from. |
sourcePort | The port of the engine to receive from. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
- Exceptions
-
void Apama.Engine.Client.IConnectOperations.AttachAsConsumerOfEngine |
( |
string |
sourceHost, |
|
|
int |
sourcePort, |
|
|
string[] |
channels, |
|
|
bool |
persistent |
|
) |
| |
Connect this engine to another so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command.
- Parameters
-
sourceHost | The host of the engine to receive from. |
sourcePort | The port of the engine to receive from. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
persistent | if true , the connection will be persistent, meaning that the receiver will automatically reconnect to the sender whenever the connection is lost. |
- Exceptions
-
void Apama.Engine.Client.IConnectOperations.AttachAsConsumerOfEngine |
( |
string |
sourceHost, |
|
|
int |
sourcePort, |
|
|
string[] |
channels, |
|
|
bool |
persistent, |
|
|
bool |
disconnectSlow, |
|
|
EngineManagement.ConnectMode |
mode |
|
) |
| |
Connect this engine to another so that it receives events emitted on the specified channels. This is equivalent to the engine_connect command.
- Parameters
-
sourceHost | The host of the engine to receive from. |
sourcePort | The port of the engine to receive from. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
persistent | if true , the connection will be persistent, meaning that the receiver will automatically reconnect to the sender whenever the connection is lost. |
disconnectSlow | if true , the connection will be disconnected if the receiver is slow |
mode | the connection mode to use, defaults to legacy (single connection, all events delivered to the default channel). Set to PARALLEL for connection per channel and channel values passed through |
- Exceptions
-
void Apama.Engine.Client.IConnectOperations.DetachAsConsumerOfEngine |
( |
IMessagingClient |
sourceEngine, |
|
|
string[] |
channels |
|
) |
| |
Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the
engine_connect –disconnect
command, and assumes the connection is non-persistent.
- Parameters
-
sourceEngine | The EngineClient instance for the engine this object is currently connected to as a consumer. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
- Exceptions
-
Apama.EngineException | Thrown if the engines cannot be disconnected, or if the channels parameter is invalid. |
void Apama.Engine.Client.IConnectOperations.DetachAsConsumerOfEngine |
( |
string |
sourceHost, |
|
|
int |
sourcePort, |
|
|
string[] |
channels |
|
) |
| |
Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the
engine_connect –disconnect
command, and assumes the connection is non-persistent.
- Parameters
-
sourceHost | The host of the engine this object is currently connected to as a consumer. |
sourcePort | The port of the engine this object is currently connected to as a consumer. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
- Exceptions
-
Apama.EngineException | Thrown if the engines cannot be disconnected, or if the channels parameter is invalid. |
void Apama.Engine.Client.IConnectOperations.DetachAsConsumerOfEngine |
( |
string |
sourceHost, |
|
|
int |
sourcePort, |
|
|
string[] |
channels, |
|
|
bool |
persistent |
|
) |
| |
Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the
engine_connect –disconnect
or engine_connect –disconnect –persistent
command.
- Parameters
-
sourceHost | The host of the engine this object is currently connected to as a consumer. |
sourcePort | The port of the engine this object is currently connected to as a consumer. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
persistent | true if the connection to be removed was persistent (i.e. the receiver automatically reconnects to the sender whenever the connection is lost). |
- Exceptions
-
Apama.EngineException | Thrown if the engines cannot be disconnected, or if the channels parameter is invalid. |
void Apama.Engine.Client.IConnectOperations.DetachAsConsumerOfEngine |
( |
string |
sourceHost, |
|
|
int |
sourcePort, |
|
|
string[] |
channels, |
|
|
bool |
persistent, |
|
|
EngineManagement.ConnectMode |
mode |
|
) |
| |
Disconnect this engine from another so that it not longer receives events emitted on the specified channels. This is equivalent to the
engine_connect –disconnect
or engine_connect –disconnect –persistent
command.
- Parameters
-
sourceHost | The host of the engine this object is currently connected to as a consumer. |
sourcePort | The port of the engine this object is currently connected to as a consumer. |
channels | the list of channels from which the engine should receive events. Must be non-null, and contain no null elements. |
persistent | true if the connection to be removed was persistent (i.e. the receiver automatically reconnects to the sender whenever the connection is lost). |
mode | the connection mode to use, defaults to legacy (single connection, all events delivered to the default channel). Set to PARALLEL for connection per channel and channel values passed through |
- Exceptions
-
Apama.EngineException | Thrown if the engines cannot be disconnected, or if the channels parameter is invalid. |
EngineConnection [] Apama.Engine.Client.IConnectOperations.GetReceiverConnections |
( |
| ) |
|
Get all the persistent connections associated with the engine.
- Returns
- An array of EngineConnection objects
- Exceptions
-
void Apama.Engine.Client.IConnectOperations.SetReceiverConnections |
( |
params EngineConnection[] |
connections | ) |
|
Attaches this component as a persistent receiver of the remote components specified in the connections argument, then decrements the reference count of any existing connections (which typically results in their removal).
Must not contain null
elements.
- Exceptions
-
Apama.EngineException | Thrown if the change in the persistent connection set failed. Note that no exception is thrown if some of the specified connections could not be established immediately - in this case the receiver will simply keep trying to reconnect in the background. |