Module io.netty5.common

Package io.netty5.util.concurrent

Interface FutureCompletionStage<V>

Type Parameters:

V - the value type.

All Superinterfaces:

CompletionStage<V>, Future<V>

All Known Implementing Classes:

DefaultPromise

public interface FutureCompletionStage<V>
extends CompletionStage<V>, Future<V>

A CompletionStage that provides the same threading semantics and guarantees as the underlying Future, which means that all the callbacks will be executed by executor() if not specified otherwise (by calling the corresponding *Async methods).

This interface also extends Future, to provide blocking methods for awaiting the result of the future. This is in contrast to the Netty Future, which is entirely non-blocking.

Please be aware that toCompletableFuture() is not supported and so will throw an UnsupportedOperationException when invoked.

Method Summary

Modifier and Type	Method	Description
FutureCompletionStage<Void>	acceptEither(CompletionStage<? extends V> other, Consumer<? super V> action)
FutureCompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends V> other, Consumer<? super V> action)
FutureCompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends V> other, Consumer<? super V> action, Executor executor)
<U> FutureCompletionStage<U>	applyToEither(CompletionStage<? extends V> other, Function<? super V,U> fn)
<U> FutureCompletionStage<U>	applyToEitherAsync(CompletionStage<? extends V> other, Function<? super V,U> fn)
<U> FutureCompletionStage<U>	applyToEitherAsync(CompletionStage<? extends V> other, Function<? super V,U> fn, Executor executor)
FutureCompletionStage<V>	await()	Waits for this future to be completed.
boolean	await(long timeout, TimeUnit unit)	Waits for this future to be completed within the specified time limit.
default boolean	cancel()
default Throwable	cause()
FutureCompletionStage<V>	exceptionally(Function<Throwable,? extends V> fn)
default EventExecutor	executor()
Future<V>	future()	Returns the underlying Future of this FutureCompletionStage.
default Throwable	getCause()	Wait for the future to complete, and return the cause if it failed, or null if it succeeded.
default V	getNow()
<U> FutureCompletionStage<U>	handle(BiFunction<? super V,Throwable,? extends U> fn)
<U> FutureCompletionStage<U>	handleAsync(BiFunction<? super V,Throwable,? extends U> fn)
<U> FutureCompletionStage<U>	handleAsync(BiFunction<? super V,Throwable,? extends U> fn, Executor executor)
default boolean	isCancellable()
boolean	isCancelled()	Return true if this operation has been cancelled.
boolean	isDone()	Return true if this operation has been completed either successfully, unsuccessfully, or through cancellation.
default boolean	isFailed()
default boolean	isSuccess()
default <T> T	join(BiFunction<V,Throwable,T> resultHandler)	Waits for the future to complete, then calls the given result handler with the outcome.
FutureCompletionStage<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
FutureCompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
FutureCompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
FutureCompletionStage<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
FutureCompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
FutureCompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
FutureCompletionStage<V>	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
FutureCompletionStage<Void>	thenAccept(Consumer<? super V> action)
FutureCompletionStage<Void>	thenAcceptAsync(Consumer<? super V> action)
FutureCompletionStage<Void>	thenAcceptAsync(Consumer<? super V> action, Executor executor)
<U> FutureCompletionStage<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super V,? super U> action)
<U> FutureCompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super V,? super U> action)
<U> FutureCompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super V,? super U> action, Executor executor)
<U> FutureCompletionStage<U>	thenApply(Function<? super V,? extends U> fn)
<U> FutureCompletionStage<U>	thenApplyAsync(Function<? super V,? extends U> fn)
<U> FutureCompletionStage<U>	thenApplyAsync(Function<? super V,? extends U> fn, Executor executor)
<U,V1> FutureCompletionStage<V1>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super V,? super U,? extends V1> fn)
<U,V1> FutureCompletionStage<V1>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super V,? super U,? extends V1> fn)
<U,V1> FutureCompletionStage<V1>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super V,? super U,? extends V1> fn, Executor executor)
<U> FutureCompletionStage<U>	thenCompose(Function<? super V,? extends CompletionStage<U>> fn)
<U> FutureCompletionStage<U>	thenComposeAsync(Function<? super V,? extends CompletionStage<U>> fn)
<U> FutureCompletionStage<U>	thenComposeAsync(Function<? super V,? extends CompletionStage<U>> fn, Executor executor)
FutureCompletionStage<Void>	thenRun(Runnable action)
FutureCompletionStage<Void>	thenRunAsync(Runnable action)
FutureCompletionStage<Void>	thenRunAsync(Runnable action, Executor executor)
default CompletableFuture<V>	toCompletableFuture()	Not supported and so throws an UnsupportedOperationException.
static <U> FutureCompletionStage<U>	toFutureCompletionStage(CompletionStage<U> stage, EventExecutor executor)	Returns a FutureCompletionStage for the given CompletionStage that is pinned to the given EventExecutor.
FutureCompletionStage<V>	whenComplete(BiConsumer<? super V,? super Throwable> action)
FutureCompletionStage<V>	whenCompleteAsync(BiConsumer<? super V,? super Throwable> action)
FutureCompletionStage<V>	whenCompleteAsync(BiConsumer<? super V,? super Throwable> action, Executor executor)

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

sync

FutureCompletionStage<V> sync()
                       throws InterruptedException

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Throws:

CancellationException - if the computation was cancelled

CompletionException - if the computation threw an exception.

InterruptedException - if the current thread was interrupted while waiting

join

default <T> T join(BiFunction<V,Throwable,T> resultHandler)
            throws InterruptedException

Waits for the future to complete, then calls the given result handler with the outcome.

If the future completes successfully, then the result handler is called with the result of the future - which may be null - and a null exception.

If the future fails, then the result handler is called with a null result, and a non-null exception.

Success or failure of the future can be determined on whether the exception is null or not.

The result handler may compute a new result, which will be the return value of the join call.

Type Parameters:

T - The return type of the resultHandler.

Parameters:

resultHandler - The function that will process the result of the completed future.

Returns:

The result of the resultHandler computation.

Throws:

InterruptedException - if the thread is interrupted while waiting for the future to complete.

await

FutureCompletionStage<V> await()
                        throws InterruptedException

Waits for this future to be completed.

Throws:

InterruptedException - if the current thread was interrupted

await

boolean await(long timeout,
              TimeUnit unit)
       throws InterruptedException

Waits for this future to be completed within the specified time limit.

Returns:

true if and only if the future was completed within the specified time limit

Throws:

InterruptedException - if the current thread was interrupted

getCause

default Throwable getCause()
                    throws InterruptedException

Wait for the future to complete, and return the cause if it failed, or null if it succeeded.

Returns:

The exception that caused the future to fail, if any, or null.

Throws:

InterruptedException - if the current thread was interrupted while waiting.

future

Future<V> future()

Returns the underlying Future of this FutureCompletionStage.

cancel

default boolean cancel()

isSuccess

default boolean isSuccess()

isFailed

default boolean isFailed()

isCancellable

default boolean isCancellable()

getNow

default V getNow()

cause

default Throwable cause()

executor

default EventExecutor executor()

toCompletableFuture

default CompletableFuture<V> toCompletableFuture()

Not supported and so throws an UnsupportedOperationException.

Specified by:

toCompletableFuture in interface CompletionStage<V>

thenApply

<U> FutureCompletionStage<U> thenApply(Function<? super V,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<V>

thenApplyAsync

<U> FutureCompletionStage<U> thenApplyAsync(Function<? super V,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<V>

thenAccept

FutureCompletionStage<Void> thenAccept(Consumer<? super V> action)

Specified by:

thenAccept in interface CompletionStage<V>

thenAcceptAsync

FutureCompletionStage<Void> thenAcceptAsync(Consumer<? super V> action)

Specified by:

thenAcceptAsync in interface CompletionStage<V>

thenRun

FutureCompletionStage<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<V>

thenRunAsync

FutureCompletionStage<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<V>

thenCombine

<U,V1> FutureCompletionStage<V1> thenCombine(CompletionStage<? extends U> other,
                                                   BiFunction<? super V,? super U,? extends V1> fn)

Specified by:

thenCombine in interface CompletionStage<V>

thenCombineAsync

<U,V1> FutureCompletionStage<V1> thenCombineAsync(CompletionStage<? extends U> other,
                                                        BiFunction<? super V,? super U,? extends V1> fn)

Specified by:

thenCombineAsync in interface CompletionStage<V>

thenAcceptBoth

<U> FutureCompletionStage<Void> thenAcceptBoth(CompletionStage<? extends U> other,
                                               BiConsumer<? super V,? super U> action)

Specified by:

thenAcceptBoth in interface CompletionStage<V>

thenAcceptBothAsync

<U> FutureCompletionStage<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                    BiConsumer<? super V,? super U> action)

Specified by:

thenAcceptBothAsync in interface CompletionStage<V>

runAfterBoth

FutureCompletionStage<Void> runAfterBoth(CompletionStage<?> other,
                                         Runnable action)

Specified by:

runAfterBoth in interface CompletionStage<V>

runAfterBothAsync

FutureCompletionStage<Void> runAfterBothAsync(CompletionStage<?> other,
                                              Runnable action)

Specified by:

runAfterBothAsync in interface CompletionStage<V>

applyToEither

<U> FutureCompletionStage<U> applyToEither(CompletionStage<? extends V> other,
                                           Function<? super V,U> fn)

Specified by:

applyToEither in interface CompletionStage<V>

applyToEitherAsync

<U> FutureCompletionStage<U> applyToEitherAsync(CompletionStage<? extends V> other,
                                                Function<? super V,U> fn)

Specified by:

applyToEitherAsync in interface CompletionStage<V>

acceptEither

FutureCompletionStage<Void> acceptEither(CompletionStage<? extends V> other,
                                         Consumer<? super V> action)

Specified by:

acceptEither in interface CompletionStage<V>

acceptEitherAsync

FutureCompletionStage<Void> acceptEitherAsync(CompletionStage<? extends V> other,
                                              Consumer<? super V> action)

Specified by:

acceptEitherAsync in interface CompletionStage<V>

runAfterEither

FutureCompletionStage<Void> runAfterEither(CompletionStage<?> other,
                                           Runnable action)

Specified by:

runAfterEither in interface CompletionStage<V>

runAfterEitherAsync

FutureCompletionStage<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                Runnable action)

Specified by:

runAfterEitherAsync in interface CompletionStage<V>

thenCompose

<U> FutureCompletionStage<U> thenCompose(Function<? super V,? extends CompletionStage<U>> fn)

Specified by:

thenCompose in interface CompletionStage<V>

thenComposeAsync

<U> FutureCompletionStage<U> thenComposeAsync(Function<? super V,? extends CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface CompletionStage<V>

whenComplete

FutureCompletionStage<V> whenComplete(BiConsumer<? super V,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<V>

whenCompleteAsync

FutureCompletionStage<V> whenCompleteAsync(BiConsumer<? super V,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<V>

handle

<U> FutureCompletionStage<U> handle(BiFunction<? super V,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<V>

handleAsync

<U> FutureCompletionStage<U> handleAsync(BiFunction<? super V,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<V>

thenApplyAsync

<U> FutureCompletionStage<U> thenApplyAsync(Function<? super V,? extends U> fn,
                                            Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<V>

thenAcceptAsync

FutureCompletionStage<Void> thenAcceptAsync(Consumer<? super V> action,
                                            Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<V>

thenRunAsync

FutureCompletionStage<Void> thenRunAsync(Runnable action,
                                         Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<V>

thenCombineAsync

<U,V1> FutureCompletionStage<V1> thenCombineAsync(CompletionStage<? extends U> other,
                                                        BiFunction<? super V,? super U,? extends V1> fn,
                                                        Executor executor)

Specified by:

thenCombineAsync in interface CompletionStage<V>

thenAcceptBothAsync

<U> FutureCompletionStage<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                    BiConsumer<? super V,? super U> action,
                                                    Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<V>

runAfterBothAsync

FutureCompletionStage<Void> runAfterBothAsync(CompletionStage<?> other,
                                              Runnable action,
                                              Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<V>

applyToEitherAsync

<U> FutureCompletionStage<U> applyToEitherAsync(CompletionStage<? extends V> other,
                                                Function<? super V,U> fn,
                                                Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<V>

acceptEitherAsync

FutureCompletionStage<Void> acceptEitherAsync(CompletionStage<? extends V> other,
                                              Consumer<? super V> action,
                                              Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<V>

runAfterEitherAsync

FutureCompletionStage<Void> runAfterEitherAsync(CompletionStage<?> other,
                                                Runnable action,
                                                Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<V>

thenComposeAsync

<U> FutureCompletionStage<U> thenComposeAsync(Function<? super V,? extends CompletionStage<U>> fn,
                                              Executor executor)

Specified by:

thenComposeAsync in interface CompletionStage<V>

exceptionally

FutureCompletionStage<V> exceptionally(Function<Throwable,? extends V> fn)

Specified by:

exceptionally in interface CompletionStage<V>

whenCompleteAsync

FutureCompletionStage<V> whenCompleteAsync(BiConsumer<? super V,? super Throwable> action,
                                           Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<V>

handleAsync

<U> FutureCompletionStage<U> handleAsync(BiFunction<? super V,Throwable,? extends U> fn,
                                         Executor executor)

Specified by:

handleAsync in interface CompletionStage<V>

toFutureCompletionStage

static <U> FutureCompletionStage<U> toFutureCompletionStage(CompletionStage<U> stage,
                                                            EventExecutor executor)

Returns a FutureCompletionStage for the given CompletionStage that is pinned to the given EventExecutor.

isCancelled

boolean isCancelled()

Return true if this operation has been cancelled.

Returns:

true if this operation has been cancelled, otherwise false.

isDone

boolean isDone()

Return true if this operation has been completed either successfully, unsuccessfully, or through cancellation.

Returns:

true if this operation has completed, otherwise false.