Package dev.getelements.elements.rt.remote

Interface AsyncControlClient

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

JeroMQAsyncControlClient

public interface AsyncControlClient
extends AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AsyncControlClient.Factory	Used to open on-demand instances of the ControlClient.
static interface	AsyncControlClient.Request	Represents a pending request that this AsyncControlClient is making.
static interface	AsyncControlClient.Response<T>	Represents a response produced by the remote end.
static interface	AsyncControlClient.ResponseConsumer<T>	Response

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this instance of AsyncControlClient.
AsyncControlClient.Request	closeBinding(NodeId nodeId, AsyncControlClient.ResponseConsumer<Void> responseConsumer)	Issues the command to close a binding.
AsyncControlClient.Request	closeRoutesViaInstance(InstanceId instanceId, String instanceConnectAddress, AsyncControlClient.ResponseConsumer<Void> responseConsumer)	Close the routes via the InstanceId.
AsyncControlClient.Request	getInstanceStatus(AsyncControlClient.ResponseConsumer<InstanceStatus> responseConsumer)	Gets the InstanceId for the remote instance.
AsyncControlClient.Request	openBinding(NodeId nodeId, AsyncControlClient.ResponseConsumer<InstanceConnectionService.InstanceBinding> responseConsumer)	Opens an InstanceConnectionService.InstanceBinding provided the NodeId and returns the InstanceConnectionService.InstanceBinding.
AsyncControlClient.Request	openRouteToNode(NodeId nodeId, String instanceInvokerAddress, AsyncControlClient.ResponseConsumer<String> responseConsumer)	Issues the command to open up a route to the node.
default AsyncControlClient	withDispatch(Consumer<Runnable> dispatch)	Configures this AsyncControlClient to dispatch the response handling to the supplied Consumer<Runnable>.

Method Details

getInstanceStatus

AsyncControlClient.Request getInstanceStatus(AsyncControlClient.ResponseConsumer<InstanceStatus> responseConsumer)

Gets the InstanceId for the remote instance.

Parameters:

responseConsumer - the Consumer<AsyncControlClient.Response<InstanceStatus>> to handle the request

Returns:

the AsyncControlClient.Request for the instance status

openRouteToNode

AsyncControlClient.Request openRouteToNode(NodeId nodeId,
 String instanceInvokerAddress,
 AsyncControlClient.ResponseConsumer<String> responseConsumer)

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

Parameters:

nodeId - the NodeId

instanceInvokerAddress - the remote instance invoker address

responseConsumer - the Consumer<AsyncControlClient.Response<String>> to handle the request

Returns:

the connect address for the node

closeRoutesViaInstance

AsyncControlClient.Request closeRoutesViaInstance(InstanceId instanceId,
 String instanceConnectAddress,
 AsyncControlClient.ResponseConsumer<Void> responseConsumer)

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

Parameters:

instanceId - the InstanceId

openBinding

AsyncControlClient.Request openBinding(NodeId nodeId,
 AsyncControlClient.ResponseConsumer<InstanceConnectionService.InstanceBinding> responseConsumer)

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

Parameters:

nodeId - the NodeId

Returns:

the InstanceConnectionService.InstanceBinding

closeBinding

AsyncControlClient.Request closeBinding(NodeId nodeId,
 AsyncControlClient.ResponseConsumer<Void> responseConsumer)

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

Parameters:

nodeId -

withDispatch

default AsyncControlClient withDispatch(Consumer<Runnable> dispatch)

Configures this AsyncControlClient to dispatch the response handling to the supplied Consumer<Runnable>. There are cases in which it may be desirable to dispatch the actual interactions with a background thread or process. For example the async callbacks to the underlying types may be using one of a few critical IO threads, it would be imperative to avoid blocking such threads. Therefore, the operations may dispatch to the supplied dispatcher.

Parameters:

dispatch - accepts a Runnable to run at now or a greater point in time.

Returns:

a wrapped AsyncControlClient which dispatches it's work to the supplied dispatch.

close

void close()

Closes this instance of AsyncControlClient. Any pending tasks will be failed with a callback to any pending responses.

Specified by:

close in interface AutoCloseable