soil-query-core/soil.query/QueryOptions

QueryOptions

interface QueryOptions : ActorOptions, LoggingOptions, RetryOptions

QueryOptions providing settings related to the internal behavior of an Query.

Inheritors

Types

object Default : QueryOptions

Properties

abstract val gcTime: Duration

The period during which the Key's return value, if not referenced anywhere, is temporarily cached in memory.

abstract val keepAliveTime: Duration

Duration to remain state as an active.

abstract val logger: LoggerFn?

Specifies the logger function.

abstract val onError: (ErrorRecord, QueryModel<*>) -> Unit?

This callback function will be called if some query encounters an error.

pauseDurationAfter

abstract val pauseDurationAfter: (Throwable) -> Duration??

Determines whether query processing needs to be paused based on error.

prefetchWindowTime

abstract val prefetchWindowTime: Duration

Maximum window time on prefetch processing.

abstract val retryCount: Int

The number of times to retry the operation.

retryInitialInterval

abstract val retryInitialInterval: Duration

The initial interval for retrying the operation.

retryMaxInterval

abstract val retryMaxInterval: Duration

The maximum interval for retrying the operation.

retryMultiplier

abstract val retryMultiplier: Double

The multiplier for the next interval.

retryRandomizationFactor

abstract val retryRandomizationFactor: Double

The randomization factor for the next interval.

retryRandomizer

abstract val retryRandomizer: Random

The random number generator for the next interval.

revalidateOnFocus

abstract val revalidateOnFocus: Boolean

Automatically revalidate active Query when the window is refocused.

revalidateOnReconnect

abstract val revalidateOnReconnect: Boolean

Automatically revalidate active Query when the network reconnects.

abstract val shouldRetry: (Throwable) -> Boolean

Specifies whether to retry the operation.

shouldSuppressErrorRelay

abstract val shouldSuppressErrorRelay: (ErrorRecord, QueryModel<*>) -> Boolean?

Determines whether to suppress error information when relaying it using soil.query.core.ErrorRelay.

abstract val staleTime: Duration

The duration after which the returned value of the fetch function block is considered stale.

Functions

calculateBackoffInterval

fun RetryOptions.calculateBackoffInterval(attempt: Int): Duration

fun QueryOptions.copy(staleTime: Duration = this.staleTime, gcTime: Duration = this.gcTime, prefetchWindowTime: Duration = this.prefetchWindowTime, pauseDurationAfter: (Throwable) -> Duration?? = this.pauseDurationAfter, revalidateOnReconnect: Boolean = this.revalidateOnReconnect, revalidateOnFocus: Boolean = this.revalidateOnFocus, onError: (ErrorRecord, QueryModel<*>) -> Unit? = this.onError, shouldSuppressErrorRelay: (ErrorRecord, QueryModel<*>) -> Boolean? = this.shouldSuppressErrorRelay, keepAliveTime: Duration = this.keepAliveTime, logger: LoggerFn? = this.logger, shouldRetry: (Throwable) -> Boolean = this.shouldRetry, retryCount: Int = this.retryCount, retryInitialInterval: Duration = this.retryInitialInterval, retryMaxInterval: Duration = this.retryMaxInterval, retryMultiplier: Double = this.retryMultiplier, retryRandomizationFactor: Double = this.retryRandomizationFactor, retryRandomizer: Random = this.retryRandomizer): QueryOptions

Copies the current QueryOptions with the specified settings.

exponentialBackOff

fun <T> RetryOptions.exponentialBackOff(onRetry: RetryCallback? = null): RetryFn<T>

Generates an RetryFn for Exponential Backoff Strategy.