methanol.kotlin/com.github.mizosoft.methanol.kotlin/RetryInterceptorSpec

RetryInterceptorSpec

@Spec

interface RetryInterceptorSpec

A spec for configuring an Interceptor that retries requests based on the specified retry conditions.

See RetryInterceptor.Builder.

Functions

backoff

abstract fun backoff(backoffStrategy: BackoffStrategy)

beginWith

abstract fun beginWith(requestModifier: (<Error class: unknown class>) -> <Error class: unknown class>)

listener

abstract fun listener(listener: RetryListener)

open fun listener(block: RetryListenerSpec.() -> Unit): <Error class: unknown class>

maxRetries

abstract fun maxRetries(maxRetries: Int)

abstract fun on(predicate: (RetryContext<*>) -> Boolean, requestModifier: RetryContext<*>.() -> <Error class: unknown class> = { request() })

onException

abstract fun onException(vararg exceptionTypes: KClass<out Throwable>)

abstract fun onException(exceptionPredicate: (Throwable) -> Boolean)

abstract fun onException(exceptionPredicate: (Throwable) -> Boolean, requestModifier: RetryContext<*>.() -> <Error class: unknown class> = { request() })

abstract fun onException(exceptionTypes: Set<KClass<out Throwable>>, requestModifier: RetryContext<*>.() -> <Error class: unknown class> = { request() })

onException

@JvmName(name = "reifiedOnException1")

inline fun <T : Throwable> RetryInterceptorSpec.onException(noinline requestModifier: RetryContext<*>.() -> <Error class: unknown class> = { request() }): <Error class: unknown class>

Retries when an exception of type T is thrown. Equivalent to onException(setOf(T::class), requestModifier).

onlyIf

abstract fun onlyIf(block: (<Error class: unknown class>) -> Boolean)

onResponse

abstract fun onResponse(responsePredicate: (<Error class: unknown class><T>) -> Boolean, requestModifier: RetryContext<*>.() -> <Error class: unknown class> = { request() })

onStatus

abstract fun onStatus(vararg codes: Int)

abstract fun onStatus(statusPredicate: (Int) -> Boolean, requestModifier: RetryContext<*>.() -> <Error class: unknown class> = { request() })

abstract fun onStatus(codes: Set<Int>, requestModifier: RetryContext<*>.() -> <Error class: unknown class> = { request() })

throwOnExhaustion

abstract fun throwOnExhaustion()

timeout

abstract fun timeout(timeout: Duration)