Struct reool::RedisPool

pub struct RedisPool<T: Poolable = ConnectionFlavour> { /* fields omitted */ }

A pool to one or more Redis instances.

This is the core type of this library.

Overview

Each RedisPool consist of one or more sub pools whereas each sub pool is only ever connected to one Redis node.

So the number of sub pools is usually the number of nodes to connect to. Furthermore the number of sub pools can be increased via the configuration.

Reool uses a stream to enqueue checkouts. Furthermore the number of buffered checkout requests is always limited. Having multiple sub pools will increase the number of checkout requests that can be enqueued.

When having more that one sub pool Reool will retry checkout attempts on different sub pools.

Methods

impl RedisPool

pub fn builder() -> Builder

impl<T: Poolable> RedisPool<T>

pub fn no_pool() -> Self

pub fn check_out_default(&self) -> Checkout<T>

Checkout a new connection and if the request has to be enqueued use a timeout as defined by the pool as a default.

pub fn check_out<M: Into<CheckoutMode>>(&self, mode: M) -> Checkout<T>

Checkout a new connection and choose whether to wait for a connection or not as defined by the CheckoutMode.

pub fn connected_to(&self) -> Vec<String>

pub fn state(&self) -> PoolState

pub fn ping<TO: Into<Timeout>>(
    &self,
    timeout: TO
) -> impl Future<Item = Vec<Ping>, Error = ()> + Send

Ping all the nodes which this pool is connected to.

timeout is the maximum time allowed for a ping.

This method only fails with () if the underlying connection does not support pinging. All other errors will be contained in the returned Ping struct.

Trait Implementations

impl<T: Poolable> Clone for RedisPool<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.