public interface ConnectOperationsInterface
Modifier and Type | Method and Description |
---|---|
void |
attachAsConsumerOfEngine(EngineClientBean sourceEngineBean,
java.lang.String[] channels)
Connect this engine to another (non-persisently) so that it receives
events emitted on the specified channels.
|
void |
attachAsConsumerOfEngine(java.lang.String sourceHost,
int sourcePort,
java.lang.String[] channels)
Connect this engine to another (non-persistently) so that it receives
events emitted on the specified channels.
|
void |
attachAsConsumerOfEngine(java.lang.String sourceHost,
int sourcePort,
java.lang.String[] channels,
boolean disconnectSlow)
Connect this engine to another so that it receives events emitted on
the specified channels.
|
void |
attachAsConsumerOfEngine(java.lang.String sourceHost,
int sourcePort,
java.lang.String[] channels,
boolean disconnectSlow,
ConnectMode mode)
Connect this engine to another so that it receives events emitted on
the specified channels.
|
void |
detachAsConsumerOfEngine(EngineClientBean sourceEngineBean,
java.lang.String[] channels)
Disconnect this engine from another so that it not longer receives events
emitted on the specified channels.
|
void |
detachAsConsumerOfEngine(EngineClientBean sourceEngineBean,
java.lang.String[] channels,
ConnectMode mode)
Disconnect this engine from another so that it not longer receives events
emitted on the specified channels.
|
void |
detachAsConsumerOfEngine(java.lang.String sourceHost,
int sourcePort,
java.lang.String[] channels)
Disconnect this engine from another so that it not longer receives events
emitted on the specified channels.
|
void |
detachAsConsumerOfEngine(java.lang.String sourceHost,
int sourcePort,
java.lang.String[] channels,
ConnectMode mode)
Disconnect this engine from another so that it not longer receives events
emitted on the specified channels.
|
EngineConnection[] |
getReceiverConnections()
Get all the persistent connections associated with the engine.
|
void |
setPersistentReceiveConnections(EngineConnection... connections)
Deprecated.
use
setReceiverConnections(EngineConnection... ) instead |
void |
setReceiverConnections(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).
|
void attachAsConsumerOfEngine(EngineClientBean sourceEngineBean, java.lang.String[] channels) throws EngineException
sourceEngineBean
- The EngineClientBean 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.EngineException
- if the engines cannot be connected, or if the
channels parameter is invalid.void attachAsConsumerOfEngine(java.lang.String sourceHost, int sourcePort, java.lang.String[] channels) throws EngineException
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.EngineException
- if the engines cannot be connected, or if the
channels parameter is invalid.void attachAsConsumerOfEngine(java.lang.String sourceHost, int sourcePort, java.lang.String[] channels, boolean disconnectSlow) throws EngineException
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.disconnectSlow
- Whether we should be disconnected if we don't keep up.
Only the first connection's disconnectSlow value is used; subsequent connections
to the same correlator (even if via different EngineManagement objects) share
the connection and thus the disconnect behaviour.EngineException
- if the engines cannot be connected, or if the
channels parameter is invalid.void attachAsConsumerOfEngine(java.lang.String sourceHost, int sourcePort, java.lang.String[] channels, boolean disconnectSlow, ConnectMode mode) throws EngineException
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.disconnectSlow
- Whether we should be disconnected if we don't keep up.
Only the first connection's disconnectSlow value is used; subsequent connections
to the same correlator (even if via different EngineManagement objects) share
the connection and thus the disconnect behaviour.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.EngineException
- if the engines cannot be connected, or if the
channels parameter is invalid.void detachAsConsumerOfEngine(EngineClientBean sourceEngineBean, java.lang.String[] channels) throws EngineException
engine_connect --disconnect
command, and assumes the
connection is non-persistent.sourceEngineBean
- The EngineClientBean 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.EngineException
- if the engines cannot be disconnected, or if the
channels parameter is invalid.void detachAsConsumerOfEngine(EngineClientBean sourceEngineBean, java.lang.String[] channels, ConnectMode mode) throws EngineException
engine_connect --disconnect
command, and assumes the
connection is non-persistent.sourceEngineBean
- The EngineClientBean 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.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.EngineException
- if the engines cannot be disconnected, or if the
channels parameter is invalid.void detachAsConsumerOfEngine(java.lang.String sourceHost, int sourcePort, java.lang.String[] channels) throws EngineException
engine_connect --disconnect
command, and assumes the
connection is non-persistent.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.EngineException
- if the engines cannot be disconnected, or if the
channels parameter is invalid.void detachAsConsumerOfEngine(java.lang.String sourceHost, int sourcePort, java.lang.String[] channels, ConnectMode mode) throws EngineException
engine_connect --disconnect
command, and assumes the
connection is non-persistent.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.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.EngineException
- if the engines cannot be disconnected, or if the
channels parameter is invalid.@Deprecated void setPersistentReceiveConnections(EngineConnection... connections) throws EngineException
setReceiverConnections(EngineConnection... )
insteadconnections
- Must not contain null
elements.EngineException
- 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.void setReceiverConnections(EngineConnection... connections) throws EngineException
connections
- Must not contain null
elements.EngineException
- 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.EngineConnection[] getReceiverConnections() throws EngineException
EngineException
- Thrown if any exceptions occur in the Client SDK.Submit a bug or feature
Copyright (c) 2013-2017 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.