Package dev.getelements.elements.rt.remote

Interface ControlClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

JeroMQControlClient

public interface ControlClient
extends AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ControlClient.Factory	Used to open on-demand instances of the ControlClient.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this instance of ControlClient
void	closeBinding(NodeId nodeId)	Issues the command to close a binding.
void	closeRoutesViaInstance(InstanceId instanceId, String instanceConnectAddress)	Close the routes via the InstanceId.
InstanceStatus	getInstanceStatus()	Gets the InstanceId for the remote instance.
RoutingStatus	getRoutingStatus()	Gets the routing status for the system.
InstanceConnectionService.InstanceBinding	openBinding(NodeId nodeId)	Opens an InstanceConnectionService.InstanceBinding provided the NodeId and returns the InstanceConnectionService.InstanceBinding.
String	openRouteToNode(NodeId nodeId, String instanceInvokerAddress)	Issues the command to open up a route to the node.
void	setReceiveTimeout(long timeout, TimeUnit timeUnit)	Allows for the adjustment of this ControlClient's receive timeout.

Method Details

getRoutingStatus

RoutingStatus getRoutingStatus()

Gets the routing status for the system.

Returns:

the routing status.

getInstanceStatus

InstanceStatus getInstanceStatus()

Gets the InstanceId for the remote instance.

Returns:

the InstanceStatus

openRouteToNode

String openRouteToNode(NodeId nodeId,
 String instanceInvokerAddress)

Issues the command to open up a route to the node.

Parameters:

nodeId - the NodeId

instanceInvokerAddress -

Returns:

the connect address for the node

closeRoutesViaInstance

void closeRoutesViaInstance(InstanceId instanceId,
 String instanceConnectAddress)

Close the routes via the InstanceId. If no routes are known, then nothing happens.

Parameters:

instanceId - the InstanceId

openBinding

InstanceConnectionService.InstanceBinding openBinding(NodeId nodeId)

Opens an InstanceConnectionService.InstanceBinding provided the NodeId and returns the InstanceConnectionService.InstanceBinding.

Parameters:

nodeId - the NodeId

Returns:

the InstanceConnectionService.InstanceBinding

closeBinding

void closeBinding(NodeId nodeId)

Issues the command to close a binding. This will invalidate all InstanceConnectionService.InstanceBindings to that NodeId.

Parameters:

nodeId -

setReceiveTimeout

void setReceiveTimeout(long timeout,
 TimeUnit timeUnit)

Allows for the adjustment of this ControlClient's receive timeout.

Parameters:

timeout - the timeout

timeUnit - the TimeUnit

close

void close()

Closes this instance of ControlClient

Specified by:

close in interface AutoCloseable