Enum ReconnectStrategy

pub enum ReconnectStrategy {
    Fail,
    ExponentialBackoff {
        base: Duration,
        factor: f64,
        max_duration: Option<Duration>,
        max_retries: Option<usize>,
        timeout: Option<Duration>,
    },
    FibonacciBackoff {
        base: Duration,
        max_duration: Option<Duration>,
        max_retries: Option<usize>,
        timeout: Option<Duration>,
    },
    FixedInterval {
        interval: Duration,
        max_retries: Option<usize>,
        timeout: Option<Duration>,
    },
}

Represents the strategy to apply when attempting to reconnect the client to the server.

Variants

Fail

A retry strategy that will fail immediately if a reconnect is attempted.

ExponentialBackoff

A retry strategy driven by exponential back-off.

Fields

base: Duration

Represents the initial time to wait between reconnect attempts.

factor: f64

Factor to use when modifying the retry time, used as a multiplier.

max_duration: Option<Duration>

Represents the maximum duration to wait between attempts. None indicates no limit.

max_retries: Option<usize>

Represents the maximum attempts to retry before failing. None indicates no limit.

timeout: Option<Duration>

Represents the maximum time to wait for a reconnect attempt. None indicates no limit.

FibonacciBackoff

A retry strategy driven by the fibonacci series.

Fields

base: Duration

Represents the initial time to wait between reconnect attempts.

max_duration: Option<Duration>

Represents the maximum duration to wait between attempts. None indicates no limit.

max_retries: Option<usize>

Represents the maximum attempts to retry before failing. None indicates no limit.

timeout: Option<Duration>

Represents the maximum time to wait for a reconnect attempt. None indicates no limit.

FixedInterval

A retry strategy driven by a fixed interval.

Fields

interval: Duration

Represents the time between reconnect attempts.

max_retries: Option<usize>

Represents the maximum attempts to retry before failing. None indicates no limit.

timeout: Option<Duration>

Represents the maximum time to wait for a reconnect attempt. None indicates no limit.

Implementations

impl ReconnectStrategy

pub async fn reconnect<T: Reconnectable>( &mut self, reconnectable: &mut T, ) -> Result<()>

pub fn is_fail(&self) -> bool

Returns true if this strategy is the fail variant.

pub fn is_exponential_backoff(&self) -> bool

Returns true if this strategy is the exponential backoff variant.

pub fn is_fibonacci_backoff(&self) -> bool

Returns true if this strategy is the fibonacci backoff variant.

pub fn is_fixed_interval(&self) -> bool

Returns true if this strategy is the fixed interval variant.

pub fn max_duration(&self) -> Option<Duration>

Returns the maximum duration between reconnect attempts, or None if there is no limit.

pub fn max_retries(&self) -> Option<usize>

Returns the maximum reconnect attempts the strategy will perform, or None if will attempt forever.

pub fn timeout(&self) -> Option<Duration>

Returns the timeout per reconnect attempt that is associated with the strategy.

Trait Implementations

impl Clone for ReconnectStrategy

fn clone(&self) -> ReconnectStrategy

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReconnectStrategy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReconnectStrategy

fn default() -> Self

Creates a reconnect strategy that will immediately fail.