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 set_factor(self, factor: u64) -> ConnectionManagerConfig

A multiplicative factor that will be applied to the retry delay.

For example, using a factor of 1000 will make each delay in units of seconds.

pub fn set_max_delay(self, time: u64) -> 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: u64) -> 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: Duration) -> ConnectionManagerConfig

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

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

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

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::protocol field.

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.

pub fn set_tcp_settings(self, tcp_settings: TcpSettings) -> Self

Set the behavior of the underlying TCP connection.

Trait Implementations

impl Clone for ConnectionManagerConfig

fn clone(&self) -> ConnectionManagerConfig

Returns a copy 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.