soil-query-core/soil.query/SubscriptionCommand/Context

Context

interface Context<T>

Context for subscription command.

Parameters

T

Type of the receive value from the subscription.

Properties

abstract val dispatch: SubscriptionDispatch<T>

abstract val options: SubscriptionOptions

abstract val relay: SubscriptionErrorRelay?

abstract val restart: SubscriptionRestart

abstract val state: SubscriptionModel<T>

Functions

dispatchReceiveFailure

fun <T> SubscriptionCommand.Context<T>.dispatchReceiveFailure(error: Throwable)

Dispatches the failure result of the subscription.

dispatchReceiveSuccess

fun <T> SubscriptionCommand.Context<T>.dispatchReceiveSuccess(data: T, contentEquals: SubscriptionContentEquals<T>? = null)

Dispatches the success result of the subscription.

fun <T> SubscriptionCommand.Context<T>.dispatchResult(key: SubscriptionKey<T>, result: Result<T>, marker: Marker)

Dispatches the result of the subscription.

reportSubscriptionError

fun <T> SubscriptionCommand.Context<T>.reportSubscriptionError(error: Throwable, id: UniqueId, marker: Marker)

Reports the subscription error.