Package dev.getelements.elements.rt.remote

Interface RemoteInvoker

All Known Implementing Classes:

JeroMQRemoteInvoker

public interface RemoteInvoker

Holds a connection to the remote service and dispatches Invocation.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_TIMEOUT	The default timeout for the RemoteInvoker
static final TimeUnit	DEFAULT_TIMEOUT_UNITS	The default time unit for the RemoteInvoker.
static final String	REMOTE_INVOKER_MAX_CONNECTIONS	The maximum underlying connections to maintain.
static final String	REMOTE_INVOKER_MIN_CONNECTIONS	The minimum underlying connections to maintain.

Method Summary

Modifier and Type	Method	Description
String	getConnectAddress()	Gets the connection address for this RemoteInvoker.
default Future<Object>	invoke(Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Deprecated. This maps directly to invokeFuture(Invocation, List, InvocationErrorConsumer), but was renamed for clarity on the behavior.
AsyncOperation	invokeAsync(Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
default Void	invokeAsyncV(Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
CompletionStage<Object>	invokeCompletionStage(Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
default Future<Object>	invokeFuture(Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
default Object	invokeSync(Invocation invocation, List<Consumer<InvocationResult>> asyncInvocationResultConsumerList, InvocationErrorConsumer asyncInvocationErrorConsumer)	Sends the Invocation to the remote service and waits for the InvocationResult.
default void	start(String connectAddress)	Starts this RemoteInvoker and connects to the supplied address.
void	start(String connectAddress, long timeout, TimeUnit timeoutTimeUnit)	Starts up thin is complete.
default void	stop()	Stops this RemoteInvoker.

Field Details

DEFAULT_TIMEOUT

static final long DEFAULT_TIMEOUT

The default timeout for the RemoteInvoker

See Also:

• Constant Field Values

DEFAULT_TIMEOUT_UNITS

static final TimeUnit DEFAULT_TIMEOUT_UNITS

The default time unit for the RemoteInvoker.

REMOTE_INVOKER_MIN_CONNECTIONS

static final String REMOTE_INVOKER_MIN_CONNECTIONS

The minimum underlying connections to maintain.

See Also:

• Constant Field Values

REMOTE_INVOKER_MAX_CONNECTIONS

static final String REMOTE_INVOKER_MAX_CONNECTIONS

The maximum underlying connections to maintain.

See Also:

• Constant Field Values

Method Details

getConnectAddress

String getConnectAddress()

Gets the connection address for this RemoteInvoker. This should be the last value passed to start(String) or start(String, long, TimeUnit).

Returns:

the connect address

start

default void start(String connectAddress)

Starts this RemoteInvoker and connects to the supplied address.

Parameters:

connectAddress - the connect address

start

void start(String connectAddress,
 long timeout,
 TimeUnit timeoutTimeUnit)

Starts up thin is complete. 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.

invoke

@Deprecated
default Future<Object> invoke(Invocation invocation,
 List<Consumer<InvocationResult>> asyncInvocationResultConsumerList,
 InvocationErrorConsumer asyncInvocationErrorConsumer)

Deprecated.

This maps directly to invokeFuture(Invocation, List, InvocationErrorConsumer), but was renamed for clarity on the behavior. This is not very useful because it can force more threads than are necessary to create a remote invocation.

Parameters:

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

invokeAsyncV

default Void invokeAsyncV(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:

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 and ease of integration with Reflections

invokeAsync

AsyncOperation invokeAsync(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:

invocation - the outgoing Invocation

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

asyncInvocationErrorConsumer - a Consumer<InvocationError> to receive async errors

Returns:

an instance of AsyncOperation

invokeFuture

default Future<Object> invokeFuture(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:

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

invokeCompletionStage

CompletionStage<Object> invokeCompletionStage(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:

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

default Object invokeSync(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(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:

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