Skip to main content

SseRetryConfig

Struct SseRetryConfig 

Source
pub struct SseRetryConfig {
    pub max_retries: u32,
    pub max_backoff_ms: u32,
    pub min_sleep_ms: u32,
    pub backoff_multiplier: f32,
    pub jitter: bool,
}
Expand description

Configuration for exponential backoff and jitter during stream reconnections.

Fields§

§max_retries: u32

The maximum number of consecutive connection attempts before giving up.

§max_backoff_ms: u32

The absolute maximum wait time between connection attempts in milliseconds.

§min_sleep_ms: u32

The absolute minimum wait time between connection attempts in milliseconds.

§backoff_multiplier: f32

The multiplier applied to the delay after each failed attempt.

§jitter: bool

Whether to apply randomness (jitter) to the reconnect delay.

Implementations§

Source§

impl SseRetryConfig

Source

pub const fn new() -> Self

Creates a new retry configuration with sensible defaults.

The default configuration applies an exponential backoff multiplier of 2.0, caps the maximum delay at 60,000 milliseconds (1 minute), caps the number of retries to 20, and enables jitter to prevent thundering herd scenarios.

§Example
use sse_core::SseRetryConfig;

let config = SseRetryConfig::new();
assert_eq!(config.max_backoff_ms, 60_000);
assert!(config.jitter);
Source

pub const fn disabled() -> Self

Creates a retry configuration that disables all automatic retries.

Source

pub fn calculate_backoff_with_factor( &self, reconnect_time_ms: u32, attempt: u32, jitter_factor: f32, ) -> Option<Duration>

Calculates the delay duration for the next reconnection attempt.

Returns None if the attempt count exceeds Self::max_retries.

Source

pub fn calculate_backoff( &self, reconnect_time_ms: u32, attempt: u32, ) -> Option<Duration>

Calculates the delay duration for the next reconnection attempt.

Returns None if the attempt count exceeds Self::max_retries.

Trait Implementations§

Source§

impl Clone for SseRetryConfig

Source§

fn clone(&self) -> SseRetryConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SseRetryConfig

Source§

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

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

impl Default for SseRetryConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for SseRetryConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SseRetryConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for SseRetryConfig

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<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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,