Package dev.getelements.elements.rt.remote

Interface RemoteInvocationDispatcher

All Known Implementing Classes:

SimpleRemoteInvocationDispatcher

public interface RemoteInvocationDispatcher

Method Summary

Modifier and Type	Method	Description
AsyncOperation	invokeAsync(Route route, Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
default Void	invokeAsyncV(Route route, Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Invokes invokeAsyncV(Route, Invocation, List, InvocationErrorConsumer), ignoring the returned AsyncOperation.
Future<Object>	invokeFuture(Route route, Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
Object	invokeSync(Route route, Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
default void	start()	Starts up this dispatcher.
default void	stop()	Stops this RemoteInvoker.

Method Details

start

default void start()

Starts up this dispatcher. The default implementation of this method does nothing in case no setup is necessary.

stop

default void stop()

Stops this RemoteInvoker. This method must gracefully shut down all connections and stop any worker threads. THe default implementation of this method does nothing in case no shutdown is necessary.

invokeAsyncV

default Void invokeAsyncV(Route route,
 Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)

Invokes invokeAsyncV(Route, Invocation, List, InvocationErrorConsumer), ignoring the returned AsyncOperation.

invokeAsync

AsyncOperation invokeAsync(Route route,
 Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)

Sends the Invocation to the remote service and waits for the InvocationResult. The supplied Consumer<InvocationError> will relay all encountered errors. Typically this is used with the Dispatch.Type.ASYNCHRONOUS. This returns the generic Void type to clarify the intention of the method that the underlying Future is discarded, but since is is intended to be used with reflections code, this allows for the method to be easily adapted as such.

Parameters:

route - the Route through which to send the Invocation

invocation - the outgoing Invocation

asyncInvocationResultConsumerList - a List<Consumer<InvocationResult>> to capture all async results

asyncInvocationErrorConsumer - a Consumer<InvocationError> to receive async errors

Returns:

a null Void, for the sake of clarity

invokeFuture

Future<Object> invokeFuture(Route route,
 Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)

Sends the Invocation to the remote service and waits for the InvocationResult. The supplied Consumer<InvocationError> will relay all encountered errors. Typically this is used with the Dispatch.Type.FUTURE

Parameters:

route - the Route through which to send the Invocation

invocation - the outgoing Invocation

asyncInvocationResultConsumerList - a List<Consumer<InvocationResult>> to capture all async results

asyncInvocationErrorConsumer - a Consumer<InvocationError> to receive async errors

Returns:

a Future<Object> which returns the result of the remote invocation

invokeSync

Object invokeSync(Route route,
 Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)
           throws Exception

Sends the Invocation to the remote service and waits for the InvocationResult. The supplied Consumer<InvocationError> will relay all encountered errors. Typically this is used with the Dispatch.Type.SYNCHRONOUS The default implementation of this method simply uses the Future<Object> returned by the method defined by invokeFuture(Route, Invocation, List, InvocationErrorConsumer) and blocks on Future.get(). However, the underlying implementation should override this method to implement a more efficient means of blocking, such as actually blocking on the underlying network socket.

Parameters:

route - the Route through which to send the Invocation

invocation - the outgoing Invocation

asyncInvocationResultConsumerList - a List<Consumer<InvocationResult>> to capture all async results

asyncInvocationErrorConsumer - a Consumer<InvocationError> to receive async errors

Returns:

the result of the remote Invocation

Throws:

Exception