Struct Sentinel 

pub struct Sentinel { /* private fields */ }

Available on crate feature sentinel only.

The Sentinel type, serves as a special purpose client which builds other clients on demand.

Implementations

impl Sentinel

pub fn build<T: IntoConnectionInfo>(params: Vec<T>) -> RedisResult<Sentinel>

Available on crate feature tls-rustls only.

Creates a Sentinel client performing some basic checks on the URLs that might make the operation fail.

pub fn master_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Determines the master’s address for the given name, and returns a client for that master. This will connect to the master node to verify that it considers itself master so errors can originate from interaction either with Sentinel or with the master node.

pub fn get_replica_clients( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Vec<Client>>

Returns Redis Client objects for all valid replicas of the given master name. Each client can be used to establish a connection later.

This may return errors originating from either Sentinel or during client construction.

pub fn replica_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Connects to a randomly chosen replica of the given master name.

pub fn replica_rotate_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Attempts to connect to a different replica of the given master name each time. There is no guarantee that we’ll actually be connecting to a different replica in the next call, but in a static set of replicas (no replicas added or removed), on average we’ll choose each replica the same number of times.

impl Sentinel

pub async fn async_master_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Determines the master’s address for the given name, and returns a client for that master. This will connect to the master node to verify that it considers itself master so errors can originate from interaction either with Sentinel or with the master node.

pub async fn async_get_replica_clients( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Vec<Client>>

Returns Redis Client objects for all valid replicas of the given master name. Each client can be used to establish a connection later.

This may return errors originating from either Sentinel or during client construction.

pub async fn async_replica_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Connects to a randomly chosen replica of the given master name. Errors can originate from interaction either with Sentinel or with the replica.

pub async fn async_replica_rotate_for( &mut self, service_name: &str, node_connection_info: Option<&SentinelNodeConnectionInfo>, ) -> RedisResult<Client>

Attempts to connect to a different replica of the given master name each time. There is no guarantee that we’ll actually be connecting to a different replica in the next call, but in a static set of replicas (no replicas added or removed), on average we’ll choose each replica the same number of times.