io.datakernel.async

Interface Stage<T>

All Known Implementing Classes:

NextStage, SettableStage

public interface Stage<T>

Replacement of default java CompletionStage interface.

See Also:

SettableStage

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Stage.ThrowingFunction<T,R>

Field Summary

Fields

Modifier and Type	Field and Description
static AsyncTimeoutException	TIMEOUT_EXCEPTION

Method Summary

Modifier and Type	Method and Description
Stage<Void>	both(Stage<?> other) Combines two Stage in one and completes when both have been completed.
<U,V> Stage<V>	combine(Stage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn) Combines two Stage in one using fn.
Stage<T>	either(Stage<? extends T> other) Combines two Stage in one.
static <T> Stage<T>	of(T value) Creates successfully completed Stage
static <T> Stage<T>	of(T value, Throwable throwable) Creates a completed stage from value and throwable variables.
static <T> Stage<T>	ofCallable(Executor executor, Callable<? extends T> callable) Runs some task in other thread (executed by a given Executor) and returns a Stage for it.
static <T> Stage<T>	ofCallback(Consumer<SettableStage<T>> callbackConsumer)
static <T> Stage<T>	ofCompletionStage(CompletionStage<? extends T> completionStage) Wraps Java CompletionStage in a Stage, running it in current eventloop.
static <T> Stage<T>	ofException(Throwable throwable) Creates exceptionally completed Stage
static <T> Stage<T>	ofFuture(CompletableFuture<? extends T> future) Creates a Stage wrapper around default java CompletableFuture and runs it immediately.
static <T> Stage<T>	ofFuture(Executor executor, Future<? extends T> future) Wraps Java Future in a Stage running it with given executor.
static Stage<Void>	ofRunnable(Executor executor, Runnable runnable) Adapter for ofThrowingRunnable(Executor, ThrowingRunnable)
static Stage<Void>	ofThrowingRunnable(Executor executor, ThrowingRunnable runnable) Same as ofCallable(Executor, Callable), but without a result (returned stage is only a marker of completion).
Stage<T>	post() When this stage is completed it's completion will be postponed to the next eventloop tick.
Stage<T>	postTo(Eventloop eventloop)
<U,S extends BiConsumer<? super T,Throwable> & Stage<U>> Stage<U>	then(S stage) Executes given stage after execution of this stage completes
<U> Stage<U>	thenApply(Function<? super T,? extends U> fn) Applies fn to the result of this Stage
<U> Stage<U>	thenApplyEx(BiFunction<? super T,Throwable,? extends U> fn) Applies fn to the result or exception of this Stage
default <U> Stage<U>	thenCallback(BiConsumer<? super T,SettableStage<U>> fn)
<U> Stage<U>	thenCompose(Function<? super T,? extends Stage<U>> fn) Applies function to the result of this stage if it completes successfully.
<U> Stage<U>	thenComposeEx(BiFunction<? super T,Throwable,? extends Stage<U>> fn) Applies function to the result of this stage.
Stage<T>	thenException(Function<? super T,Throwable> fn)
Stage<T>	thenRun(Runnable action) Runs action after successful completion of this stage
Stage<T>	thenRunEx(Runnable action) Runs action after completion of this stage
default <U> Stage<U>	thenTry(Stage.ThrowingFunction<? super T,? extends U> fn)
Stage<T>	timeout(Duration timeout) Returns stage that completes successfully if this stage completes before timeout.
CompletableFuture<T>	toCompletableFuture() Wraps Stage into CompletableFuture
Stage<Try<T>>	toTry() Returns stage that always completes successfully with result or exception wrapped in Try
Stage<Void>	toVoid() Waits for result and discard it.
Stage<T>	whenComplete(BiConsumer<? super T,Throwable> action) Subscribes given action to be executed after this stage completes
Stage<T>	whenException(Consumer<Throwable> action) Subscribes given action to be executed after this stage completes exceptionally
Stage<T>	whenResult(Consumer<? super T> action) Subscribes given action to be executed after this stage completes successfully

Field Detail

TIMEOUT_EXCEPTION

static final AsyncTimeoutException TIMEOUT_EXCEPTION

Method Detail

of

static <T> Stage<T> of(@Nullable
                       T value)

Creates successfully completed Stage

Parameters:

value - result of Stage

ofException

static <T> Stage<T> ofException(Throwable throwable)

Creates exceptionally completed Stage

Parameters:

throwable - Exception

ofCallback

static <T> Stage<T> ofCallback(Consumer<SettableStage<T>> callbackConsumer)

of

static <T> Stage<T> of(@Nullable
                       T value,
                       @Nullable
                       Throwable throwable)

Creates a completed stage from value and throwable variables. Useful for thenComposeEx(BiFunction) passthroughs (eg. when mapping specific exceptions).

Parameters:

value - value to wrap when exception is null

throwable - possibly-null exception, determines type of stage completion

ofFuture

static <T> Stage<T> ofFuture(CompletableFuture<? extends T> future)

Creates a Stage wrapper around default java CompletableFuture and runs it immediately.

Returns:

result of the given future wrapped in a Stage

ofCompletionStage

static <T> Stage<T> ofCompletionStage(CompletionStage<? extends T> completionStage)

Wraps Java CompletionStage in a Stage, running it in current eventloop.

Parameters:

completionStage - completion stage itself

Returns:

result of the given completionStage wrapped in a Stage

ofFuture

static <T> Stage<T> ofFuture(Executor executor,
                             Future<? extends T> future)

Wraps Java Future in a Stage running it with given executor.

Parameters:

executor - executor to execute the future concurrently

future - the future itself

Returns:

result of the future wrapped in a Stage

ofCallable

static <T> Stage<T> ofCallable(Executor executor,
                               Callable<? extends T> callable)

Runs some task in other thread (executed by a given Executor) and returns a Stage for it. Also manages external task count for current eventloop, so it wont shut down until the task is complete.

Parameters:

executor - executor to execute the task concurrently

callable - the task itself

Returns:

Stage for the given task

ofThrowingRunnable

static Stage<Void> ofThrowingRunnable(Executor executor,
                                      ThrowingRunnable runnable)

Same as ofCallable(Executor, Callable), but without a result (returned stage is only a marker of completion).

ofRunnable

static Stage<Void> ofRunnable(Executor executor,
                              Runnable runnable)

Adapter for ofThrowingRunnable(Executor, ThrowingRunnable)

then

<U,S extends BiConsumer<? super T,Throwable> & Stage<U>> Stage<U> then(S stage)

Executes given stage after execution of this stage completes

Type Parameters:

U - type of result

Parameters:

stage - given stage

Returns:

subscribed Stage

thenApply

<U> Stage<U> thenApply(Function<? super T,? extends U> fn)

Applies fn to the result of this Stage

Parameters:

fn - function to apply

Returns:

Stage that will apply given function

thenApplyEx

<U> Stage<U> thenApplyEx(BiFunction<? super T,Throwable,? extends U> fn)

Applies fn to the result or exception of this Stage

Parameters:

fn - function to apply

Returns:

Stage that will apply given function

thenRun

Stage<T> thenRun(Runnable action)

Runs action after successful completion of this stage

Parameters:

action - to be executed

Returns:

this stage

thenRunEx

Stage<T> thenRunEx(Runnable action)

Runs action after completion of this stage

Parameters:

action - to be executed

Returns:

this stage

thenCompose

<U> Stage<U> thenCompose(Function<? super T,? extends Stage<U>> fn)

Applies function to the result of this stage if it completes successfully. Returned stage will be completed when stage returned from function completes.

Parameters:

fn - to be applied

thenComposeEx

<U> Stage<U> thenComposeEx(BiFunction<? super T,Throwable,? extends Stage<U>> fn)

Applies function to the result of this stage. Returned stage will be completed when stage returned from function completes.

Parameters:

fn - to be applied

Returns:

this stage

thenCallback

default <U> Stage<U> thenCallback(BiConsumer<? super T,SettableStage<U>> fn)

whenComplete

Stage<T> whenComplete(BiConsumer<? super T,Throwable> action)

Subscribes given action to be executed after this stage completes

Parameters:

action - to be executed

Returns:

this Stage

whenResult

Stage<T> whenResult(Consumer<? super T> action)

Subscribes given action to be executed after this stage completes successfully

Parameters:

action - to be executed

Returns:

this Stage

whenException

Stage<T> whenException(Consumer<Throwable> action)

Subscribes given action to be executed after this stage completes exceptionally

Parameters:

action - to be executed

Returns:

this Stage

thenException

Stage<T> thenException(Function<? super T,Throwable> fn)

thenTry

default <U> Stage<U> thenTry(Stage.ThrowingFunction<? super T,? extends U> fn)

combine

<U,V> Stage<V> combine(Stage<? extends U> other,
                       BiFunction<? super T,? super U,? extends V> fn)

Combines two Stage in one using fn.

Parameters:

other - Stage to combine

fn - function to combine results of both stages into one

Returns:

Stage that completes when fn was applied on the result of both stages

both

Stage<Void> both(Stage<?> other)

Combines two Stage in one and completes when both have been completed.

Parameters:

other - Stage to combine

either

Stage<T> either(Stage<? extends T> other)

Combines two Stage in one.

Parameters:

other - Stage to combine

Returns:

result of the first completed Stage

toTry

Stage<Try<T>> toTry()

Returns stage that always completes successfully with result or exception wrapped in Try

See Also:

Try

toVoid

Stage<Void> toVoid()

Waits for result and discard it.

timeout

Stage<T> timeout(@Nullable
                 Duration timeout)

Returns stage that completes successfully if this stage completes before timeout. Otherwise it completes with timeout exception. If null is given, no timeout is applied.

Parameters:

timeout - timeout in milliseconds

post

Stage<T> post()

When this stage is completed it's completion will be postponed to the next eventloop tick.

postTo

Stage<T> postTo(Eventloop eventloop)

toCompletableFuture

CompletableFuture<T> toCompletableFuture()

Wraps Stage into CompletableFuture