Package-level declarations

Types

Link copied to clipboard
interface Actor

An actor represents a launch entry point for processing a query or mutation command.

Link copied to clipboard
interface ActorOptions

Interface providing settings related to the internal behavior of an Actor.

Link copied to clipboard
interface BatchScheduler

Scheduler for batching tasks.

Link copied to clipboard
fun interface BatchSchedulerFactory

Factory for creating BatchScheduler instances.

Link copied to clipboard
typealias BatchTask = () -> Unit
Link copied to clipboard
external interface Crypto
Link copied to clipboard
interface DataModel<out T>
Link copied to clipboard
external object Date
Link copied to clipboard
external interface Document
Link copied to clipboard
data class ErrorRecord

Error information that can be received via a back-channel such as ErrorRelay or onError options for Query/Mutation.

Link copied to clipboard
interface ErrorRelay

An interface for relaying error information via a back-channel when an error occurs during execution, regardless of Query/Mutation.

Link copied to clipboard

A policy for relaying error information.

Link copied to clipboard
fun interface LoggerFn

Logger functional interface to output log messages.

Link copied to clipboard
interface LoggingOptions

Interface providing settings for logging output for debugging purposes.

Link copied to clipboard
interface Marker

An interface for providing additional information based on the caller of a query or mutation.

Link copied to clipboard
interface MemoryPressure

Interface for receiving events of memory pressure.

Link copied to clipboard

Levels of memory pressure.

Link copied to clipboard
value class Namespace(val value: String)

Automatically generated value for mutationId and subscriptionId.

Link copied to clipboard

Interface for receiving events of network connectivity.

Link copied to clipboard

Events of network connectivity.

Link copied to clipboard
interface NetworkOptions
Link copied to clipboard
class PriorityQueue<E : Any, Comparable<E>>(capacity: Int)

Priority queue implementation.

Link copied to clipboard
sealed interface Reply<out T>

Represents a reply from a query or mutation.

Link copied to clipboard
interface Retryable

Interface to indicate whether an Throwable is retryable, provided as a default options.

Link copied to clipboard
typealias RetryCallback = (err: Throwable, attempt: Int, nextBackOff: Duration) -> Unit

Callback function to notify the execution of retry logic.

Link copied to clipboard
fun interface RetryFn<T>

Functional interface for retry logic applied to queries or mutations within a command.

Link copied to clipboard
interface RetryOptions

Interface providing settings for retry logic.

Link copied to clipboard
typealias SurrogateKey = Any

A surrogate key for unique identifiers.

Link copied to clipboard
class TimeBasedCache<K : Any, V : Any>

A time-based cache that evicts entries based on their time-to-live (TTL).

Link copied to clipboard
interface UniqueId

Interface for unique identifiers.

Link copied to clipboard

Interface for receiving events of window visibility.

Link copied to clipboard

Events of window visibility.

Properties

Link copied to clipboard
external val crypto: Crypto
Link copied to clipboard
external val document: Document
Link copied to clipboard

Returns true if the reply is Reply.None.

Functions

Link copied to clipboard
inline fun <T1, T2, R> Reply.Companion.combine(r1: Reply<T1>, r2: Reply<T2>, transform: (T1, T2) -> R): Reply<R>

Combines two Reply instances using the provided transform function. If either Reply has no reply yet (Reply.None), returns Reply.None.

inline fun <T1, T2, T3, R> Reply.Companion.combine(r1: Reply<T1>, r2: Reply<T2>, r3: Reply<T3>, transform: (T1, T2, T3) -> R): Reply<R>

Combines three Reply instances using the provided transform function. If any Reply has no reply yet (Reply.None), returns Reply.None.

Link copied to clipboard
actual fun epoch(): Long
expect fun epoch(): Long

Returns the current epoch time.

actual fun epoch(): Long
actual fun epoch(): Long
actual fun epoch(): Long
Link copied to clipboard

Generates an RetryFn for Exponential Backoff Strategy.

Link copied to clipboard
fun <T> Reply<T>.getOrElse(default: () -> T): T

Returns the value of the Reply.Some instance, or the result of the default function if there is no reply yet (Reply.None).

Link copied to clipboard
fun <T> Reply<T>.getOrNull(): T?

Returns the value of the Reply.Some instance, or null if there is no reply yet (Reply.None).

Link copied to clipboard
fun <T> Reply<T>.getOrThrow(): T

Returns the value of the Reply.Some instance, or throws an error if there is no reply yet (Reply.None).

Link copied to clipboard
Link copied to clipboard
inline fun <T, R> Reply<T>.map(transform: (T) -> R): Reply<R>

Transforms the value of the Reply.Some instance using the provided transform function, or returns Reply.None if there is no reply yet (Reply.None).

Link copied to clipboard
inline fun <T> Reply<T>?.orNone(): Reply<T>

Returns the value of the Reply.Some instance, or the default value if there is no reply yet (Reply.None).

Link copied to clipboard
actual fun uuid(): String
expect fun uuid(): String

Generate a Version 4 UUID.

actual fun uuid(): String
actual fun uuid(): String
actual fun uuid(): String