Struct ConnectionManagerConfig 

pub struct ConnectionManagerConfig { /* private fields */ }

The configuration for reconnect mechanism and request timing for the ConnectionManager

Implementations

impl ConnectionManagerConfig

pub fn new() -> Self

Creates a new instance of the options with nothing set

pub fn min_delay(&self) -> Duration

Returns the minimum delay between connection attempts.

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

Returns the maximum delay between connection attempts.

pub fn exponent_base(&self) -> f32

Returns the base used for calculating the exponential backoff between retries.

pub fn number_of_retries(&self) -> usize

Returns the maximum number of connection retry attempts.

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

Returns the timeout applied to command responses.

If None, responses do not time out.

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

Returns the timeout applied to establishing a new connection.

If None, connection attempts to do not time out.

pub fn automatic_resubscription(&self) -> bool

Returns true if automatic resubscription is enabled after reconnecting.

pub fn set_min_delay(self, min_delay: Duration) -> ConnectionManagerConfig

Set the minimal delay for reconnect attempts.

pub fn set_max_delay(self, time: Duration) -> ConnectionManagerConfig

Apply a maximum delay between connection attempts. The delay between attempts won’t be longer than max_delay milliseconds.

pub fn set_exponent_base(self, base: f32) -> ConnectionManagerConfig

The resulting duration is calculated by taking the base to the n-th power, where n denotes the number of past attempts.

pub fn set_number_of_retries(self, amount: usize) -> ConnectionManagerConfig

number_of_retries times, with an exponentially increasing delay.

pub fn set_response_timeout( self, duration: Option<Duration>, ) -> ConnectionManagerConfig

The new connection will time out operations after response_timeout has passed.

Set None if you don’t want requests to time out.

pub fn set_connection_timeout( self, duration: Option<Duration>, ) -> ConnectionManagerConfig

Each connection attempt to the server will time out after connection_timeout.

Set None if you don’t want the connection attempt to time out.

pub fn set_push_sender(self, sender: impl AsyncPushSender) -> Self

Sets sender sender for push values.

The sender can be a channel, or an arbitrary function that handles crate::PushInfo values. This will fail client creation if the connection isn’t configured for RESP3 communications via the crate::RedisConnectionInfo::set_protocol function.

Examples

let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel();
let config = ConnectionManagerConfig::new().set_push_sender(tx);

let messages = Arc::new(Mutex::new(Vec::new()));
let config = ConnectionManagerConfig::new().set_push_sender(move |msg|{
    let Ok(mut messages) = messages.lock() else {
        return Err(redis::aio::SendError);
    };
    messages.push(msg);
    Ok(())
});

pub fn set_automatic_resubscription(self) -> Self

Configures the connection manager to automatically resubscribe to all pubsub channels after reconnecting.

Trait Implementations

impl Clone for ConnectionManagerConfig

fn clone(&self) -> ConnectionManagerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionManagerConfig

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

Formats the value using the given formatter.

impl Default for ConnectionManagerConfig

fn default() -> Self

Returns the “default value” for a type.