Package dev.restate.sdk.common.syscalls

Interface Syscalls

All Known Implementing Classes:

SyscallsImpl

public interface Syscalls

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

When using executor switching wrappers, the method's callback will be executed in the state machine executor.

Method Summary

Modifier and Type	Method	Description
void	awakeable(SyscallCallback<Map.Entry<String,Deferred<ByteBuffer>>> callback)
void	call(Target target, ByteBuffer parameter, SyscallCallback<Deferred<ByteBuffer>> callback)
void	clear(String name, SyscallCallback<Void> callback)
void	clearAll(SyscallCallback<Void> callback)
Deferred<Void>	createAllDeferred(List<Deferred<?>> children)
Deferred<Integer>	createAnyDeferred(List<Deferred<?>> children)
void	enterSideEffectBlock(@Nullable String name, EnterSideEffectSyscallCallback callback)
void	exitSideEffectBlock(ByteBuffer toWrite, ExitSideEffectSyscallCallback callback)
void	exitSideEffectBlockWithException(Throwable toWrite, @Nullable RetryPolicy retryPolicy, ExitSideEffectSyscallCallback callback)
void	exitSideEffectBlockWithTerminalException(TerminalException toWrite, ExitSideEffectSyscallCallback callback)	Deprecated, for removal: This API element is subject to removal in a future version. use exitSideEffectBlockWithException(Throwable, RetryPolicy, ExitSideEffectSyscallCallback) instead.
void	fail(Throwable cause)
void	get(String name, SyscallCallback<Deferred<ByteBuffer>> callback)
void	getKeys(SyscallCallback<Deferred<Collection<String>>> callback)
boolean	isInsideSideEffect()
String	objectKey()
void	peekPromise(String key, SyscallCallback<Deferred<ByteBuffer>> callback)
void	promise(String key, SyscallCallback<Deferred<ByteBuffer>> callback)
void	rejectAwakeable(String id, String reason, SyscallCallback<Void> requestCallback)
void	rejectPromise(String key, String reason, SyscallCallback<Deferred<Void>> callback)
Request	request()
void	resolveAwakeable(String id, ByteBuffer payload, SyscallCallback<Void> requestCallback)
<T> void	resolveDeferred(Deferred<T> deferredToResolve, SyscallCallback<Void> callback)
void	resolvePromise(String key, ByteBuffer payload, SyscallCallback<Deferred<Void>> callback)
void	send(Target target, ByteBuffer parameter, @Nullable Duration delay, SyscallCallback<Void> requestCallback)
void	set(String name, ByteBuffer value, SyscallCallback<Void> callback)
void	sleep(Duration duration, SyscallCallback<Deferred<Void>> callback)
void	writeOutput(TerminalException exception, SyscallCallback<Void> callback)
void	writeOutput(ByteBuffer value, SyscallCallback<Void> callback)

Method Details

objectKey

String objectKey()

request

Request request()

isInsideSideEffect

boolean isInsideSideEffect()

Returns:

true if it's inside a side effect block.

writeOutput

void writeOutput(ByteBuffer value,
 SyscallCallback<Void> callback)

writeOutput

void writeOutput(TerminalException exception,
 SyscallCallback<Void> callback)

get

void get(String name,
 SyscallCallback<Deferred<ByteBuffer>> callback)

getKeys

void getKeys(SyscallCallback<Deferred<Collection<String>>> callback)

clear

void clear(String name,
 SyscallCallback<Void> callback)

clearAll

void clearAll(SyscallCallback<Void> callback)

set

void set(String name,
 ByteBuffer value,
 SyscallCallback<Void> callback)

sleep

void sleep(Duration duration,
 SyscallCallback<Deferred<Void>> callback)

call

void call(Target target,
 ByteBuffer parameter,
 SyscallCallback<Deferred<ByteBuffer>> callback)

send

void send(Target target,
 ByteBuffer parameter,
 @Nullable Duration delay,
 SyscallCallback<Void> requestCallback)

enterSideEffectBlock

void enterSideEffectBlock(@Nullable String name,
 EnterSideEffectSyscallCallback callback)

exitSideEffectBlock

void exitSideEffectBlock(ByteBuffer toWrite,
 ExitSideEffectSyscallCallback callback)

exitSideEffectBlockWithTerminalException

@Deprecated(since="1.1.0",
            forRemoval=true)
void exitSideEffectBlockWithTerminalException(TerminalException toWrite,
 ExitSideEffectSyscallCallback callback)

Deprecated, for removal: This API element is subject to removal in a future version.

use exitSideEffectBlockWithException(Throwable, RetryPolicy, ExitSideEffectSyscallCallback) instead.

exitSideEffectBlockWithException

void exitSideEffectBlockWithException(Throwable toWrite,
 @Nullable RetryPolicy retryPolicy,
 ExitSideEffectSyscallCallback callback)

awakeable

void awakeable(SyscallCallback<Map.Entry<String,Deferred<ByteBuffer>>> callback)

resolveAwakeable

void resolveAwakeable(String id,
 ByteBuffer payload,
 SyscallCallback<Void> requestCallback)

rejectAwakeable

void rejectAwakeable(String id,
 String reason,
 SyscallCallback<Void> requestCallback)

promise

void promise(String key,
 SyscallCallback<Deferred<ByteBuffer>> callback)

peekPromise

void peekPromise(String key,
 SyscallCallback<Deferred<ByteBuffer>> callback)

resolvePromise

void resolvePromise(String key,
 ByteBuffer payload,
 SyscallCallback<Deferred<Void>> callback)

rejectPromise

void rejectPromise(String key,
 String reason,
 SyscallCallback<Deferred<Void>> callback)

fail

void fail(Throwable cause)

resolveDeferred

<T> void resolveDeferred(Deferred<T> deferredToResolve,
 SyscallCallback<Void> callback)

createAnyDeferred

Deferred<Integer> createAnyDeferred(List<Deferred<?>> children)

createAllDeferred

Deferred<Void> createAllDeferred(List<Deferred<?>> children)