redis::aio

Struct ConnectionManagerConfig

Source
pub struct ConnectionManagerConfig { /* private fields */ }
Expand description

The configuration for reconnect mechanism and request timing for the ConnectionManager

Implementations§

Source§

impl ConnectionManagerConfig

Source

pub fn new() -> Self

Creates a new instance of the options with nothing set

Source

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.

Source

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.

Source

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.

Source

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

number_of_retries times, with an exponentially increasing delay

Source

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

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

Source

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

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

Source

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. Setting this will mean that the connection manager actively listens to updates from the server, and so it will cause the manager to reconnect after a disconnection, even if the manager was unused at the time of the disconnect.

§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(())
});
Source

pub fn set_automatic_resubscription(self) -> Self

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

Source

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

Set the behavior of the underlying TCP connection.

Trait Implementations§

Source§

impl Clone for ConnectionManagerConfig

Source§

fn clone(&self) -> ConnectionManagerConfig

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

Source§

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

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

impl Default for ConnectionManagerConfig

Source§

fn default() -> Self

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

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T