Catalyst/io.circul.catalyst.predicate/RetryPredicate

RetryPredicate

Represents a retry predicate that determines whether a block of code should be retried based on the result of its execution and the current retry count.

The shouldRetry method must be implemented to specify the retry condition.

In addition to shouldRetry, this interface provides default implementations for boolean logic operations, allowing for the creation of complex retry conditions by combining multiple retry predicates.

Usage:

val alwaysRetry = object : RetryPredicate {
    override fun shouldRetry(result: Result<Any?>, retryCount: Int) = true
}

Since

1.0.0

Properties

asRetryPolicy

val RetryPredicate.asRetryPolicy: RetryPolicy

Converts a RetryPredicate to a RetryPolicy with a DelayStrategy of noDelay

Functions

and

open infix fun and(other: RetryPredicate): RetryPredicate

Combines this predicate with another using logical AND (conjunction).

nand

open infix fun nand(other: RetryPredicate): RetryPredicate

Combines this predicate with another using logical NAND.

nor

open infix fun nor(other: RetryPredicate): RetryPredicate

Combines this predicate with another using logical NOR.

not

open operator fun not(): RetryPredicate

Negates the retry condition, inverting the result of shouldRetry.

open infix fun or(other: RetryPredicate): RetryPredicate

Combines this predicate with another using logical OR (disjunction).

shouldRetry

abstract fun shouldRetry(result: Result<Any?>, retryCount: Int, elapsedTime: Duration): Boolean

Called by RetryPolicy.retry, determines whether a retry should be performed based on the result of execution and the retryCount.

with

infix fun RetryPredicate.with(that: DelayStrategy): RetryPolicy

Combines a RetryPredicate with a DelayStrategy to create a RetryPolicy.

xnor

open infix fun xnor(other: RetryPredicate): RetryPredicate

Combines this predicate with another using logical XNOR.

xor

open infix fun xor(other: RetryPredicate): RetryPredicate

Combines this predicate with another using logical XOR (exclusive OR).