Package dev.restate.sdk

Class Awaitable<T>

java.lang.Object

dev.restate.sdk.Awaitable<T>

Type Parameters:

T - type of the awaitable result

Direct Known Subclasses:

AnyAwaitable, Awakeable

public abstract class Awaitable<T>
extends Object

An Awaitable allows to await an asynchronous result. Once await() is called, the execution stops until the asynchronous result is available.

The result can be either a success or a failure. In case of a failure, await() will throw a TerminalException.

NOTE: This interface MUST NOT be accessed concurrently since it can lead to different orderings of user actions, corrupting the execution of the invocation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Syscalls	syscalls

Method Summary

Modifier and Type	Method	Description
static Awaitable<Void>	all(Awaitable<?> first, Awaitable<?> second, Awaitable<?>... others)	Create an Awaitable that awaits all the given awaitables.
static Awaitable<Void>	all(List<Awaitable<?>> awaitables)	Create an Awaitable that awaits all the given awaitables.
static AnyAwaitable	any(Awaitable<?> first, Awaitable<?> second, Awaitable<?>... others)	Create an Awaitable that awaits any of the given awaitables.
static AnyAwaitable	any(List<Awaitable<?>> awaitables)	Create an Awaitable that awaits any of the given awaitables.
final T	await()	Wait for the current awaitable to complete.
final T	await(Duration timeout)	Same as await(), but throws a TimeoutException if this Awaitable doesn't complete before the provided timeout.
protected abstract Result<T>	awaitResult()
protected abstract Deferred<?>	deferred()
final <U> Awaitable<U>	map(ThrowingFunction<T,U> mapper)	Map the result of this Awaitable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

syscalls

protected final Syscalls syscalls

Method Details

deferred

protected abstract Deferred<?> deferred()

awaitResult

protected abstract Result<T> awaitResult()

await

public final T await()
              throws TerminalException

Wait for the current awaitable to complete. Executing this method may trigger the suspension of the function.

NOTE: You should never wrap this invocation in a try-catch catching RuntimeException, as it will catch AbortedExecutionException as well.

Throws:

TerminalException - if the awaitable is ready and contains a failure

await

public final T await(Duration timeout)
              throws TerminalException,
TimeoutException

Same as await(), but throws a TimeoutException if this Awaitable doesn't complete before the provided timeout.

Throws:

TerminalException

TimeoutException

map

public final <U> Awaitable<U> map(ThrowingFunction<T,U> mapper)

Map the result of this Awaitable.

any

public static AnyAwaitable any(Awaitable<?> first,
 Awaitable<?> second,
 Awaitable<?>... others)

Create an Awaitable that awaits any of the given awaitables.

The behavior is the same as CompletableFuture.anyOf(CompletableFuture[]).

any

public static AnyAwaitable any(List<Awaitable<?>> awaitables)

Create an Awaitable that awaits any of the given awaitables.

An empty list is not supported and will throw IllegalArgumentException.

The behavior is the same as CompletableFuture.anyOf(CompletableFuture[]).

all

public static Awaitable<Void> all(Awaitable<?> first,
 Awaitable<?> second,
 Awaitable<?>... others)

Create an Awaitable that awaits all the given awaitables.

The behavior is the same as CompletableFuture.allOf(CompletableFuture[]).

all

public static Awaitable<Void> all(List<Awaitable<?>> awaitables)

Create an Awaitable that awaits all the given awaitables.

An empty list is not supported and will throw IllegalArgumentException.

The behavior is the same as CompletableFuture.allOf(CompletableFuture[]).