soil-query-core/soil.query/QueryOptions/Default

Default

object Default : QueryOptions

Properties

open override val errorEquals: (Throwable, Throwable) -> Boolean? = null

Determines whether two errors are equal.

open override val gcTime: Duration

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

open override val keepAliveTime: Duration

Duration to remain state as an active.

open override val logger: LoggerFn? = null

Specifies the logger function.

open override val onError: (ErrorRecord, QueryModel<*>) -> Unit? = null

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

pauseDurationAfter

open override val pauseDurationAfter: (Throwable) -> Duration?? = null

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

prefetchWindowTime

open override val prefetchWindowTime: Duration

Maximum window time on prefetch processing.

open override val retryCount: Int = 3

The number of times to retry the operation.

retryInitialInterval

open override val retryInitialInterval: Duration

The initial interval for retrying the operation.

retryMaxInterval

open override val retryMaxInterval: Duration

The maximum interval for retrying the operation.

retryMultiplier

open override val retryMultiplier: Double = 1.5

The multiplier for the next interval.

retryRandomizationFactor

open override val retryRandomizationFactor: Double = 0.5

The randomization factor for the next interval.

retryRandomizer

open override val retryRandomizer: Random

The random number generator for the next interval.

revalidateOnFocus

open override val revalidateOnFocus: Boolean = true

Automatically revalidate active Query when the window is refocused.

revalidateOnReconnect

open override val revalidateOnReconnect: Boolean = true

Automatically revalidate active Query when the network reconnects.

open override val shouldRetry: (Throwable) -> Boolean

Specifies whether to retry the operation.

shouldSuppressErrorRelay

open override val shouldSuppressErrorRelay: (ErrorRecord, QueryModel<*>) -> Boolean? = null

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

open override 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, errorEquals: (Throwable, Throwable) -> Boolean? = this.errorEquals, 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.