sdk-common/dev.restate.sdk.endpoint.definition/HandlerContext

HandlerContext

Internal interface to access Restate functionalities. Users can use the ad-hoc RestateContext interfaces provided by the various implementations.

The operations producing a result return a Handle to it. To get the result, build a future tree out of the handles (UnresolvedFuture) and await it.

Types

AwaitResult

interface AwaitResult

Result of await.

Awakeable

class Awakeable : Record

CallHandles

class CallHandles : Record

Handle

interface Handle<T>

Opaque handle to the result of an operation, returned by the HandlerContext operations, and used to build the UnresolvedFuture.Single nodes of a future tree.

Result

interface Result<T>

Result of an operation.

RunCompleter

interface RunCompleter

UnresolvedFuture

interface UnresolvedFuture

Node of a future tree, awaited with await.

Functions

attachInvocation

abstract fun attachInvocation(invocationId: String): CompletableFuture<HandlerContext.Handle<Slice>>

attemptHeaders

abstract fun attemptHeaders(): HeadersAccessor

Restate-protocol-level HTTP headers received on the current invocation attempt.

await

abstract fun await(tree: HandlerContext.UnresolvedFuture): CompletableFuture<HandlerContext.AwaitResult>

Await the given future tree, until either one of its singles completes, or the invocation is cancelled or aborted.

awakeable

abstract fun awakeable(): CompletableFuture<HandlerContext.Awakeable>

call

open fun ~~call~~(target: Target, parameter: Slice, @Nullable idempotencyKey: @Nullable String, @Nullable headers: @Nullable Collection<Map.Entry<String, String>>): CompletableFuture<HandlerContext.CallHandles>

abstract fun call(target: Target, parameter: Slice, @Nullable idempotencyKey: @Nullable String, @Nullable limitKey: @Nullable String, @Nullable headers: @Nullable Collection<Map.Entry<String, String>>): CompletableFuture<HandlerContext.CallHandles>

cancelInvocation

abstract fun cancelInvocation(invocationId: String): CompletableFuture<Void>

canReadPromises

abstract fun canReadPromises(): Boolean

canReadState

abstract fun canReadState(): Boolean

canWritePromises

abstract fun canWritePromises(): Boolean

canWriteState

abstract fun canWriteState(): Boolean

clear

abstract fun clear(name: String): CompletableFuture<Void>

clearAll

abstract fun clearAll(): CompletableFuture<Void>

fail

abstract fun fail(cause: Throwable)

get

abstract fun get(name: String): CompletableFuture<HandlerContext.Handle<Optional<Slice>>>

getInvocationOutput

abstract fun getInvocationOutput(invocationId: String): CompletableFuture<HandlerContext.Handle<Output<Slice>>>

getKeys

abstract fun getKeys(): CompletableFuture<HandlerContext.Handle<Collection<String>>>

objectKey

abstract fun objectKey(): String

payloadCodec

open fun payloadCodec(): PayloadCodec

peekPromise

abstract fun peekPromise(key: String): CompletableFuture<HandlerContext.Handle<Output<Slice>>>

promise

abstract fun promise(key: String): CompletableFuture<HandlerContext.Handle<Slice>>

rejectAwakeable

abstract fun rejectAwakeable(id: String, reason: TerminalException): CompletableFuture<Void>

rejectPromise

abstract fun rejectPromise(key: String, reason: TerminalException): CompletableFuture<HandlerContext.Handle<Void>>

rejectSignal

abstract fun rejectSignal(invocationId: String, name: String, reason: TerminalException): CompletableFuture<Void>

request

abstract fun request(): HandlerRequest

resolveAwakeable

abstract fun resolveAwakeable(id: String, payload: Slice): CompletableFuture<Void>

resolvePromise

abstract fun resolvePromise(key: String, payload: Slice): CompletableFuture<HandlerContext.Handle<Void>>

resolveSignal

abstract fun resolveSignal(invocationId: String, name: String, payload: Slice): CompletableFuture<Void>

send

open fun ~~send~~(target: Target, parameter: Slice, @Nullable idempotencyKey: @Nullable String, @Nullable headers: @Nullable Collection<Map.Entry<String, String>>, @Nullable delay: @Nullable Duration): CompletableFuture<HandlerContext.Handle<String>>

abstract fun send(target: Target, parameter: Slice, @Nullable idempotencyKey: @Nullable String, @Nullable limitKey: @Nullable String, @Nullable headers: @Nullable Collection<Map.Entry<String, String>>, @Nullable delay: @Nullable Duration): CompletableFuture<HandlerContext.Handle<String>>

set

abstract fun set(name: String, value: Slice): CompletableFuture<Void>

signal

abstract fun signal(name: String): CompletableFuture<HandlerContext.Handle<Slice>>

submitRun

abstract fun submitRun(@Nullable name: @Nullable String, closure: Consumer<HandlerContext.RunCompleter>): CompletableFuture<HandlerContext.Handle<Slice>>

timer

abstract fun timer(duration: Duration, @Nullable name: @Nullable String): CompletableFuture<HandlerContext.Handle<Void>>

writeOutput

abstract fun ~~writeOutput~~(value: Slice): CompletableFuture<Void>

abstract fun ~~writeOutput~~(exception: TerminalException): CompletableFuture<Void>