Enum fred::types::ReconnectPolicy

pub enum ReconnectPolicy {
    Constant {
        attempts: u32,
        max_attempts: u32,
        delay: u32,
        jitter: u32,
    },
    Linear {
        attempts: u32,
        max_attempts: u32,
        max_delay: u32,
        delay: u32,
        jitter: u32,
    },
    Exponential {
        attempts: u32,
        max_attempts: u32,
        min_delay: u32,
        max_delay: u32,
        mult: u32,
        jitter: u32,
    },
}

The type of reconnection policy to use. This will apply to every connection used by the client.

Use a max_attempts value of 0 to retry forever.

Variants

Constant

Wait a constant amount of time between reconnect attempts, in ms.

Fields

attempts: u32

max_attempts: u32

delay: u32

jitter: u32

Linear

Backoff reconnection attempts linearly, adding delay each time.

Fields

attempts: u32

max_attempts: u32

max_delay: u32

delay: u32

jitter: u32

Exponential

Backoff reconnection attempts exponentially, multiplying the last delay by mult each time.

Fields

attempts: u32

max_attempts: u32

min_delay: u32

max_delay: u32

mult: u32

jitter: u32

Implementations

impl ReconnectPolicy

pub fn new_constant(max_attempts: u32, delay: u32) -> ReconnectPolicy

Create a new reconnect policy with a constant backoff.

pub fn new_linear( max_attempts: u32, max_delay: u32, delay: u32, ) -> ReconnectPolicy

Create a new reconnect policy with a linear backoff.

pub fn new_exponential( max_attempts: u32, min_delay: u32, max_delay: u32, mult: u32, ) -> ReconnectPolicy

Create a new reconnect policy with an exponential backoff.

pub fn set_jitter(&mut self, jitter_ms: u32)

Set the amount of jitter to add to each reconnect delay.

Default: 50 ms

pub fn attempts(&self) -> u32

Read the number of reconnection attempts.

pub fn next_delay(&mut self) -> Option<u64>

Calculate the next delay, incrementing attempts in the process.

Trait Implementations

impl Clone for ReconnectPolicy

fn clone(&self) -> ReconnectPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReconnectPolicy

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

Formats the value using the given formatter.

impl Default for ReconnectPolicy

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ReconnectPolicy

fn eq(&self, other: &ReconnectPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ReconnectPolicy

impl StructuralPartialEq for ReconnectPolicy