KubeMQ.RetryPolicy (kubemq v1.0.1)

Retry policy for transient gRPC errors.

Applied by the transport layer when operations fail with retryable error codes (:transient, :timeout, :throttling).

Fields

max_retries (non_neg_integer()) — Maximum number of retry attempts. Default: 3.
initial_delay (pos_integer()) — First retry delay in milliseconds. Default: 100.
max_delay (pos_integer()) — Maximum retry delay in milliseconds. Default: 1_000.
multiplier (float()) — Exponential backoff multiplier. Default: 2.0.

Defaults

%KubeMQ.RetryPolicy{
  max_retries: 3,
  initial_delay: 100,
  max_delay: 1_000,
  multiplier: 2.0
}

Summary

Types

t()

Functions

delay_for_attempt(policy, attempt)

Compute the delay for the given attempt number (0-based).

from_config(config)

Build from the :retry_policy keyword list in client configuration.

new(opts \\ [])

Create a new RetryPolicy struct from keyword options.

should_retry?(retry_policy, attempt)

Returns true if the attempt number is within the retry limit.

Types

t()

@type t() :: %KubeMQ.RetryPolicy{
  initial_delay: pos_integer(),
  max_delay: pos_integer(),
  max_retries: non_neg_integer(),
  multiplier: float()
}

Functions

delay_for_attempt(policy, attempt)

@spec delay_for_attempt(t(), non_neg_integer()) :: non_neg_integer()

Compute the delay for the given attempt number (0-based).

from_config(config)

@spec from_config(keyword()) :: t()

Build from the :retry_policy keyword list in client configuration.

Examples

iex> policy = KubeMQ.RetryPolicy.from_config(max_retries: 5, initial_delay: 200)
iex> policy.max_retries
5
iex> policy.initial_delay
200

new(opts \\ [])

@spec new(keyword()) :: t()

Create a new RetryPolicy struct from keyword options.

Options

:max_retries — Maximum retry attempts (default: 3)
:initial_delay — First retry delay in ms (default: 100)
:max_delay — Maximum retry delay in ms (default: 1_000)
:multiplier — Exponential backoff multiplier (default: 2.0)

Examples

iex> policy = KubeMQ.RetryPolicy.new(max_retries: 5, initial_delay: 200)
iex> policy.max_retries
5
iex> policy.max_delay
1000

should_retry?(retry_policy, attempt)

@spec should_retry?(t(), non_neg_integer()) :: boolean()

Returns true if the attempt number is within the retry limit.