net.maritimecloud.net

Interface EndpointInvocationFuture<T>

All Superinterfaces:

DispatchedMessage, Future<T>

public interface EndpointInvocationFuture<T>
extends DispatchedMessage, Future<T>

A future interface returned when invoking a remote endpoint method.

Author:

Kasper Nielsen

Method Summary

Modifier and Type	Method and Description
T	getNow(T valueIfAbsent) Returns the result value (or throws any encountered exception) if completed, else returns the given valueIfAbsent.
void	handle(java.util.function.BiConsumer<T,Throwable> consumer) The given function is invoked with the result (or null if none) and the exception (or null if none) of this NetworkFuture when complete.
T	join() Returns the result of invoking the method when complete, or throws an (unchecked) exception if completed exceptionally.
EndpointInvocationFuture<T>	orTimeout(long timeout, TimeUnit unit) Creates a new EndpointInvocationFuture that will time out via TimeoutException if this task has not completed within the specified time.
<U> EndpointInvocationFuture<U>	thenApply(java.util.function.Function<? super T,? extends U> fn)
void	thenRun(Runnable action)
default EndpointInvocationFuture<T>	timeout(long timeout, TimeUnit unit) Deprecated.

Methods inherited from interface net.maritimecloud.net.DispatchedMessage

getMessageId, getPosition, getTime, relayed

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

getNow

T getNow(T valueIfAbsent)

Returns the result value (or throws any encountered exception) if completed, else returns the given valueIfAbsent.

Parameters:

valueIfAbsent - the value to return if not completed

Returns:

the result value, if completed, else the given valueIfAbsent

Throws:

CancellationException - if the computation was cancelled

handle

void handle(java.util.function.BiConsumer<T,Throwable> consumer)

The given function is invoked with the result (or null if none) and the exception (or null if none) of this NetworkFuture when complete.

Parameters:

consumer - the composer used for processing the result

join

T join()

Returns the result of invoking the method when complete, or throws an (unchecked) exception if completed exceptionally. To better conform with the use of common functional forms, if a computation involved in the completion of this future threw an exception, this method throws an (unchecked) CompletionException with the underlying exception as its cause.

Returns:

the result value

Throws:

CancellationException - if the invocation was cancelled

CompletionException - if this future completed exceptionally or the remote invocation threw an exception

orTimeout

EndpointInvocationFuture<T> orTimeout(long timeout,
                                      TimeUnit unit)

Creates a new EndpointInvocationFuture that will time out via TimeoutException if this task has not completed within the specified time.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the new future

thenApply

<U> EndpointInvocationFuture<U> thenApply(java.util.function.Function<? super T,? extends U> fn)

thenRun

void thenRun(Runnable action)

timeout

@Deprecated
default EndpointInvocationFuture<T> timeout(long timeout,
                                                        TimeUnit unit)

Deprecated.

use orTimeout(long, TimeUnit)