Struct stream_reconnect::ReconnectOptions

pub struct ReconnectOptions {
    pub retries_to_attempt_fn: Arc<dyn Fn() -> DurationIterator + Send + Sync>,
    pub exit_if_first_connect_fails: bool,
    pub on_connect_callback: Arc<dyn Fn() + Send + Sync>,
    pub on_disconnect_callback: Arc<dyn Fn() + Send + Sync>,
    pub on_connect_fail_callback: Arc<dyn Fn() + Send + Sync>,
}

User specified options that control the behavior of the ReconnectStream upon disconnect.

Fields

retries_to_attempt_fn: Arc<dyn Fn() -> DurationIterator + Send + Sync>

Represents a function that generates an Iterator to schedule the wait between reconnection attempts.

exit_if_first_connect_fails: bool

If this is set to true, if the initial connect method of the ReconnectStream item fails, then no further reconnects will be attempted

on_connect_callback: Arc<dyn Fn() + Send + Sync>

Invoked when the ReconnectStream establishes a connection

on_disconnect_callback: Arc<dyn Fn() + Send + Sync>

Invoked when the ReconnectStream loses its active connection

on_connect_fail_callback: Arc<dyn Fn() + Send + Sync>

Invoked when the ReconnectStream fails a connection attempt

Implementations

impl ReconnectOptions

pub fn new() -> Self

By default, the ReconnectStream will not try to reconnect if the first connect attempt fails. By default, the retries iterator waits longer and longer between reconnection attempts, until it eventually perpetually tries to reconnect every 30 minutes.

pub fn with_retries_generator<F, I, IN>(self, retries_generator: F) -> Self where
    F: 'static + Send + Sync + Fn() -> IN,
    I: 'static + Send + Sync + Iterator<Item = Duration>,
    IN: IntoIterator<IntoIter = I, Item = Duration>, 

This convenience function allows the user to provide any function that returns a value that is convertible into an iterator, such as an actual iterator or a Vec.

Examples

use std::time::Duration;
use stream_reconnect::ReconnectOptions;

// With the below vector, the ReconnectStream item will try to reconnect three times,
// waiting 2 seconds between each attempt. Once all three tries are exhausted,
// it will stop attempting.
let options = ReconnectOptions::new().with_retries_generator(|| {
    vec![
        Duration::from_secs(2),
        Duration::from_secs(2),
        Duration::from_secs(2),
    ]
});

pub fn with_exit_if_first_connect_fails(self, value: bool) -> Self

pub fn with_on_connect_callback(
    self,
    cb: impl Fn() + 'static + Send + Sync
) -> Self

pub fn with_on_disconnect_callback(
    self,
    cb: impl Fn() + 'static + Send + Sync
) -> Self

pub fn with_on_connect_fail_callback(
    self,
    cb: impl Fn() + 'static + Send + Sync
) -> Self

Trait Implementations

impl Clone for ReconnectOptions

fn clone(&self) -> ReconnectOptions

Returns a copy of the value.

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

Performs copy-assignment from source.