Skip to main content

RetryPolicy

Struct RetryPolicy 

Source
pub struct RetryPolicy {
    pub max_reconnect_attempts: u32,
    pub initial_backoff_ms: u64,
    pub max_backoff_ms: u64,
    pub backoff_multiplier: f64,
}
Expand description

Backoff knobs applied to reconnect attempts.

Backoff progression for attempt n (1-indexed) is:

min(initial_backoff_ms * backoff_multiplier.powi(n - 1), max_backoff_ms)

Examples (defaults):

attempt 1: 500 ms
attempt 2: 1000 ms
attempt 3: 2000 ms
attempt 4: 4000 ms
attempt 5: 8000 ms
attempt 6: 16000 ms  (would be next, but capped by attempts=5)

Fields§

§max_reconnect_attempts: u32

Maximum number of reconnection attempts after a connection drop or heartbeat miss. 0 disables reconnection entirely (the first connect failure surfaces). Default 5.

§initial_backoff_ms: u64

Delay before the first reconnect attempt, in milliseconds. Default 500.

§max_backoff_ms: u64

Upper bound for any single backoff delay, in milliseconds. Must be >= initial_backoff_ms. Default 30_000 (30 seconds — matches the server-side grace window so a single backoff never exceeds the window itself).

§backoff_multiplier: f64

Exponential factor applied between attempts. 2.0 doubles the delay each attempt. Must be >= 1.0; 1.0 produces constant backoff. Default 2.0.

Implementations§

Source§

impl RetryPolicy

Source

pub fn new( max_reconnect_attempts: u32, initial_backoff_ms: u64, max_backoff_ms: u64, backoff_multiplier: f64, ) -> Result<Self, Error>

Construct a validated RetryPolicy.

Returns Error::Protocol if any knob is out of range. Mirrors the Python SDK’s __post_init__ validation so an invalid policy fails loudly at construction rather than producing surprising backoff.

Source

pub fn backoff_ms(&self, attempt: u32) -> u64

Return the delay (in ms) to wait before the given attempt.

attempt is 1-indexed: attempt = 1 is the first reconnect after a drop, attempt = 2 the second, etc. An attempt of 0 is clamped to 1 (the first backoff) — the public contract is “give me the delay for the Nth retry” and there is no zeroth retry.

Trait Implementations§

Source§

impl Clone for RetryPolicy

Source§

fn clone(&self) -> RetryPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RetryPolicy

Source§

impl Debug for RetryPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RetryPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for RetryPolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for RetryPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V