soil-query-core/soil.query/MutationOptions

MutationOptions

interface MutationOptions : ActorOptions, LoggingOptions, RetryOptions

MutationOptions providing settings related to the internal behavior of an Mutation.

Inheritors

Types

object Default : MutationOptions

Properties

abstract val errorEquals: (Throwable, Throwable) -> Boolean?

Determines whether two errors are equal.

abstract val isOneShot: Boolean

Only allows mutate to execute once while active (until reset).

abstract val isStrictMode: Boolean

Requires revision match as a precondition for executing mutate.

abstract val keepAliveTime: Duration

Duration to remain state as an active.

abstract val logger: LoggerFn?

Specifies the logger function.

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

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

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.

shouldExecuteEffectSynchronously

abstract val shouldExecuteEffectSynchronously: Boolean

Whether the query side effect should be synchronous. If true, side effect will be executed synchronously.

abstract val shouldRetry: (Throwable) -> Boolean

Specifies whether to retry the operation.

shouldSuppressErrorRelay

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

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

Functions

calculateBackoffInterval

fun RetryOptions.calculateBackoffInterval(attempt: Int): Duration

fun MutationOptions.copy(isOneShot: Boolean = this.isOneShot, isStrictMode: Boolean = this.isStrictMode, errorEquals: (Throwable, Throwable) -> Boolean? = this.errorEquals, onError: (ErrorRecord, MutationModel<*>) -> Unit? = this.onError, shouldSuppressErrorRelay: (ErrorRecord, MutationModel<*>) -> Boolean? = this.shouldSuppressErrorRelay, shouldExecuteEffectSynchronously: Boolean = this.shouldExecuteEffectSynchronously, 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): MutationOptions

Copies the current MutationOptions with the specified settings.

exponentialBackOff

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

Generates an RetryFn for Exponential Backoff Strategy.