DICE API Documentation/com.embabel.dice.proposition/ConsecutiveFailureBreaker

ConsecutiveFailureBreaker

class ConsecutiveFailureBreaker constructor(val maxConsecutiveFailures: Int = DEFAULT_MAX_CONSECUTIVE_FAILURES)

Stops calling a service once maxConsecutiveFailures calls in a row have failed.

A re-embed makes one embedding call per proposition. When the embedding service is down, every call fails, and each one waits out its own timeout and retries before the next starts, so trying them all can take a very long time. With this, one bad proposition is still skipped and the run continues, but a run of failures means the service is down: the remaining propositions are not attempted, and the caller reports them as such.

Not thread-safe; use one per run.

Constructors

ConsecutiveFailureBreaker

constructor(maxConsecutiveFailures: Int = DEFAULT_MAX_CONSECUTIVE_FAILURES)

Types

Companion

object Companion

Properties

maxConsecutiveFailures

val maxConsecutiveFailures: Int

tripped

val tripped: Boolean

Whether the limit has been reached, so no more calls are made.

Functions

attempt

fun <T> attempt(call: () -> T): <Error class: unknown class><T>?

Run call and return its result, or null without running it once tripped. An Exception is returned as a failure and counts towards the limit; a success resets the count. An Error propagates.