java.lang.Object
- dev.restate.sdk.Awaitable<T>

Type Parameters:

T - type of the awaitable result

Direct Known Subclasses:

AnyAwaitable, Awakeable
```
@NotThreadSafe
public abstract class Awaitable<T>
extends java.lang.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.

Field Summary

Fields
Modifier and Type Field Description

protected dev.restate.sdk.common.syscalls.Syscalls syscalls

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static Awaitable<java.lang.Void>`	`all(Awaitable<?> first, Awaitable<?> second, Awaitable<?>... others)`	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.
`T`	`await()`	Wait for the current awaitable to complete.
`T`	`await(java.time.Duration timeout)`	Same as `await()`, but throws a `TimeoutException` if this `Awaitable` doesn't complete before the provided `timeout`.
`protected abstract dev.restate.sdk.common.syscalls.Result<T>`	`awaitResult()`
`protected abstract dev.restate.sdk.common.syscalls.Deferred<?>`	`deferred()`
`<U> Awaitable<U>`	`map(dev.restate.sdk.common.function.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 Detail

syscalls

protected final dev.restate.sdk.common.syscalls.Syscalls syscalls

Method Detail

deferred

protected abstract dev.restate.sdk.common.syscalls.Deferred<?> deferred()

awaitResult

protected abstract dev.restate.sdk.common.syscalls.Result<T> awaitResult()

await
```
public final T await()
              throws dev.restate.sdk.common.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:

dev.restate.sdk.common.TerminalException - if the awaitable is ready and contains a failure

await
```
public final T await(java.time.Duration timeout)
              throws dev.restate.sdk.common.TerminalException,
                     java.util.concurrent.TimeoutException
```
Same as await(), but throws a TimeoutException if this Awaitable doesn't complete before the provided timeout.

Throws:

dev.restate.sdk.common.TerminalException

java.util.concurrent.TimeoutException

map

public final <U> Awaitable<U> map(dev.restate.sdk.common.function.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[]).

all

public static Awaitable<java.lang.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[]).

Class Awaitable<T>

Field Summary