Struct fred::clients::SentinelClient

pub struct SentinelClient { /* private fields */ }

Available on crate feature sentinel-client only.

A struct for interacting directly with Sentinel nodes.

This struct will not communicate with Redis servers behind the sentinel interface, but rather with the sentinel nodes themselves. Callers should use the RedisClient interface with a ServerConfig::Sentinel for interacting with Redis services behind a sentinel layer.

See the sentinel API docs for more information.

Implementations

impl SentinelClient

pub fn new( config: SentinelConfig, perf: Option<PerformanceConfig>, connection: Option<ConnectionConfig>, policy: Option<ReconnectPolicy>, ) -> SentinelClient

Create a new client instance without connecting to the sentinel node.

See the builder interface for more information.

Trait Implementations

impl AclInterface for SentinelClient

Available on crate feature i-acl only.

fn acl_setuser<S, V>( &self, username: S, rules: V, ) -> impl Future<Output = RedisResult<()>>

where S: Into<Str>, V: TryInto<MultipleValues>, V::Error: Into<RedisError>,

Create an ACL user with the specified rules or modify the rules of an existing user.

fn acl_load(&self) -> impl Future<Output = RedisResult<()>>

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will reload the ACLs from the file, replacing all the current ACL rules with the ones defined in the file.

fn acl_save(&self) -> impl Future<Output = RedisResult<()>>

When Redis is configured to use an ACL file (with the aclfile configuration option), this command will save the currently defined ACLs from the server memory to the ACL file.

fn acl_list<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

The command shows the currently active ACL rules in the Redis server.

fn acl_users<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

The command shows a list of all the usernames of the currently configured users in the Redis ACL system.

fn acl_getuser<R, S>(&self, username: S) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<Str>,

The command returns all the rules defined for an existing ACL user.

fn acl_deluser<R, S>( &self, usernames: S, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<MultipleStrings>,

Delete all the specified ACL users and terminate all the connections that are authenticated with such users.

fn acl_cat<R>( &self, category: Option<Str>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

The command shows the available ACL categories if called without arguments. If a category name is given, the command shows all the Redis commands in the specified category.

fn acl_genpass<R>( &self, bits: Option<u16>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Generate a password with length bits, returning the password.

fn acl_whoami<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Return the username the current connection is authenticated with. New connections are authenticated with the “default” user.

fn acl_log_count<R>( &self, count: Option<u32>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Read count recent ACL security events.

fn acl_log_reset(&self) -> impl Future<Output = RedisResult<()>>

Clear the ACL security events logs.

impl AuthInterface for SentinelClient

fn auth<S>( &self, username: Option<String>, password: S, ) -> impl Future<Output = RedisResult<()>>

where S: Into<Str>,

Request for authentication in a password-protected Redis server. Returns ok if successful.

fn hello( &self, version: RespVersion, auth: Option<(Str, Str)>, setname: Option<Str>, ) -> impl Future<Output = RedisResult<()>>

Switch to a different protocol, optionally authenticating in the process.

impl ClientInterface for SentinelClient

Available on crate feature i-client only.

fn client_id<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Return the ID of the current connection.

fn connection_ids(&self) -> impl Future<Output = HashMap<Server, i64>>

Read the connection IDs for the active connections to each server.

fn client_info<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

The command returns information and statistics about the current client connection in a mostly human readable format.

fn client_kill<R>( &self, filters: Vec<ClientKillFilter>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Close a given connection or set of connections.

fn client_list<R, I>( &self, type: Option<ClientKillType>, ids: Option<Vec<String>>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

The CLIENT LIST command returns information and statistics about the client connections server in a mostly human readable format.

fn client_getname<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

The CLIENT GETNAME returns the name of the current connection as set by CLIENT SETNAME.

fn client_setname<S>(&self, name: S) -> impl Future<Output = RedisResult<()>>

where S: Into<Str>,

Assign a name to the current connection.

fn client_pause( &self, timeout: i64, mode: Option<ClientPauseKind>, ) -> impl Future<Output = RedisResult<()>>

CLIENT PAUSE is a connections control command able to suspend all the Redis clients for the specified amount of time (in milliseconds).

fn client_unpause(&self) -> impl Future<Output = RedisResult<()>>

CLIENT UNPAUSE is used to resume command processing for all clients that were paused by CLIENT PAUSE.

fn client_reply( &self, flag: ClientReplyFlag, ) -> impl Future<Output = RedisResult<()>>

The CLIENT REPLY command controls whether the server will reply the client’s commands. The following modes are available:

fn client_unblock<R, S>( &self, id: S, flag: Option<ClientUnblockFlag>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<RedisValue>,

This command can unblock, from a different connection, a client blocked in a blocking operation, such as for instance BRPOP or XREAD or WAIT.

fn unblock_self( &self, flag: Option<ClientUnblockFlag>, ) -> impl Future<Output = RedisResult<()>>

A convenience function to unblock any blocked connection on this client.

fn client_tracking<R, T, P>( &self, toggle: T, redirect: Option<i64>, prefixes: P, bcast: bool, optin: bool, optout: bool, noloop: bool, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, T: TryInto<Toggle>, T::Error: Into<RedisError>, P: Into<MultipleStrings>,

Available on crate feature i-tracking only.

This command enables the tracking feature of the Redis server that is used for server assisted client side caching.

fn client_trackinginfo<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Available on crate feature i-tracking only.

The command returns information about the current client connection’s use of the server assisted client side caching feature.

fn client_getredir<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Available on crate feature i-tracking only.

This command returns the client ID we are redirecting our tracking notifications to.

fn client_caching<R>( &self, enabled: bool, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Available on crate feature i-tracking only.

This command controls the tracking of the keys in the next command executed by the connection, when tracking is enabled in OPTIN or OPTOUT mode.

impl ClientLike for SentinelClient

fn id(&self) -> &str

The unique ID identifying this client and underlying connections.

fn client_config(&self) -> RedisConfig

Read the config used to initialize the client.

fn client_reconnect_policy(&self) -> Option<ReconnectPolicy>

Read the reconnect policy used to initialize the client.

fn connection_config(&self) -> &ConnectionConfig

Read the connection config used to initialize the client.

fn protocol_version(&self) -> RespVersion

Read the RESP version used by the client when communicating with the server.

fn has_reconnect_policy(&self) -> bool

Whether the client has a reconnection policy.

fn is_pipelined(&self) -> bool

Whether the client will automatically pipeline commands.

fn is_clustered(&self) -> bool

Whether the client is connected to a cluster.

fn uses_sentinels(&self) -> bool

Whether the client uses the sentinel interface.

fn update_perf_config(&self, config: PerformanceConfig)

Update the internal PerformanceConfig in place with new values.

fn perf_config(&self) -> PerformanceConfig

Read the PerformanceConfig associated with this client.

fn state(&self) -> ClientState

Read the state of the underlying connection(s).

fn is_connected(&self) -> bool

Whether all underlying connections are healthy.

fn active_connections( &self, ) -> impl Future<Output = Result<Vec<Server>, RedisError>>

Read the set of active connections managed by the client.

fn server_version(&self) -> Option<Version>

Read the server version, if known.

fn set_resolver(&self, resolver: Rc<dyn Resolve>) -> impl Future

Available on crate feature dns only.

Override the DNS resolution logic for the client.

fn connect(&self) -> ConnectHandle

Connect to the server.

fn force_reconnection(&self) -> impl Future<Output = RedisResult<()>>

Force a reconnection to the server(s).

fn wait_for_connect(&self) -> impl Future<Output = RedisResult<()>>

Wait for the result of the next connection attempt.

fn init(&self) -> impl Future<Output = RedisResult<ConnectHandle>>

Initialize a new routing and connection task and wait for it to connect successfully.

fn quit(&self) -> impl Future<Output = RedisResult<()>>

Close the connection to the Redis server. The returned future resolves when the command has been written to the socket, not when the connection has been fully closed. Some time after this future resolves the future returned by connect will resolve which indicates that the connection has been fully closed.

fn shutdown( &self, flags: Option<ShutdownFlags>, ) -> impl Future<Output = RedisResult<()>>

Available on crate feature i-server only.

Shut down the server and quit the client.

fn flushall<R>(&self, async: bool) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Delete the keys in all databases.

fn flushall_cluster(&self) -> impl Future<Output = RedisResult<()>>

Delete the keys on all nodes in the cluster. This is a special function that does not map directly to the Redis interface.

fn ping<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Ping the Redis server.

fn info<R>( &self, section: Option<InfoKind>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Read info about the server.

fn custom<R, T>( &self, cmd: CustomCommand, args: Vec<T>, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, T: TryInto<RedisValue>, T::Error: Into<RedisError>,

Run a custom command that is not yet supported via another interface on this client. This is most useful when interacting with third party modules or extensions.

fn custom_raw<T>( &self, cmd: CustomCommand, args: Vec<T>, ) -> impl Future<Output = RedisResult<Resp3Frame>>

where T: TryInto<RedisValue>, T::Error: Into<RedisError>,

Run a custom command similar to custom, but return the response frame directly without any parsing.

fn with_options(&self, options: &Options) -> WithOptions<Self>

Customize various configuration options on commands.

impl Clone for SentinelClient

fn clone(&self) -> SentinelClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SentinelClient

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

Formats the value using the given formatter.

impl EventInterface for SentinelClient

fn on_message<F>(&self, func: F) -> JoinHandle<RedisResult<()>>

where F: Fn(Message) -> RedisResult<()> + 'static,

Spawn a task that runs the provided function on each publish-subscribe message.

fn on_keyspace_event<F>(&self, func: F) -> JoinHandle<RedisResult<()>>

where F: Fn(KeyspaceEvent) -> RedisResult<()> + 'static,

Spawn a task that runs the provided function on each keyspace event.

fn on_reconnect<F>(&self, func: F) -> JoinHandle<RedisResult<()>>

where F: Fn(Server) -> RedisResult<()> + 'static,

Spawn a task that runs the provided function on each reconnection event.

fn on_cluster_change<F>(&self, func: F) -> JoinHandle<RedisResult<()>>

where F: Fn(Vec<ClusterStateChange>) -> RedisResult<()> + 'static,

Spawn a task that runs the provided function on each cluster change event.

fn on_error<F>(&self, func: F) -> JoinHandle<RedisResult<()>>

where F: Fn(RedisError) -> RedisResult<()> + 'static,

Spawn a task that runs the provided function on each connection error event.

fn on_unresponsive<F>(&self, func: F) -> JoinHandle<RedisResult<()>>

where F: Fn(Server) -> RedisResult<()> + 'static,

Spawn a task that runs the provided function whenever the client detects an unresponsive connection.

fn on_any<Fe, Fr, Fc>( &self, error_fn: Fe, reconnect_fn: Fr, cluster_change_fn: Fc, ) -> JoinHandle<RedisResult<()>>

where Fe: Fn(RedisError) -> RedisResult<()> + 'static, Fr: Fn(Server) -> RedisResult<()> + 'static, Fc: Fn(Vec<ClusterStateChange>) -> RedisResult<()> + 'static,

Spawn one task that listens for all connection management event types.

fn message_rx(&self) -> BroadcastReceiver<Message>

Listen for messages on the publish-subscribe interface.

fn keyspace_event_rx(&self) -> BroadcastReceiver<KeyspaceEvent>

Listen for keyspace and keyevent notifications on the publish-subscribe interface.

fn reconnect_rx(&self) -> BroadcastReceiver<Server>

Listen for reconnection notifications.

fn cluster_change_rx(&self) -> BroadcastReceiver<Vec<ClusterStateChange>>

Listen for notifications whenever the cluster state changes.

fn error_rx(&self) -> BroadcastReceiver<RedisError>

Listen for protocol and connection errors. This stream can be used to more intelligently handle errors that may not appear in the request-response cycle, and so cannot be handled by response futures.

fn unresponsive_rx(&self) -> BroadcastReceiver<Server>

Receive a message when the client initiates a reconnection after detecting an unresponsive connection.

impl HeartbeatInterface for SentinelClient

Available on crate feature i-server only.

fn enable_heartbeat( &self, interval: Duration, break_on_error: bool, ) -> impl Future<Output = RedisResult<()>>

Return a future that will ping the server on an interval.

impl MetricsInterface for SentinelClient

fn read_redelivery_count(&self) -> usize

Read the number of request redeliveries.

fn take_redelivery_count(&self) -> usize

Read and reset the number of request redeliveries.

fn command_queue_len(&self) -> usize

Read the number of buffered commands that have not yet been sent to the server.

fn read_latency_metrics(&self) -> Stats

Available on crate feature metrics only.

Read latency metrics across all commands.

fn take_latency_metrics(&self) -> Stats

Available on crate feature metrics only.

Read and consume latency metrics, resetting their values afterwards.

fn read_network_latency_metrics(&self) -> Stats

Available on crate feature metrics only.

Read network latency metrics across all commands.

fn take_network_latency_metrics(&self) -> Stats

Available on crate feature metrics only.

Read and consume network latency metrics, resetting their values afterwards.

fn read_req_size_metrics(&self) -> Stats

Available on crate feature metrics only.

Read request payload size metrics across all commands.

fn take_req_size_metrics(&self) -> Stats

Available on crate feature metrics only.

Read and consume request payload size metrics, resetting their values afterwards.

fn read_res_size_metrics(&self) -> Stats

Available on crate feature metrics only.

Read response payload size metrics across all commands.

fn take_res_size_metrics(&self) -> Stats

Available on crate feature metrics only.

Read and consume response payload size metrics, resetting their values afterwards.

impl PubsubInterface for SentinelClient

Available on crate feature i-pubsub only.

fn subscribe<S>(&self, channels: S) -> impl Future<Output = RedisResult<()>>

where S: Into<MultipleStrings>,

Subscribe to a channel on the publish-subscribe interface.

fn unsubscribe<S>(&self, channels: S) -> impl Future<Output = RedisResult<()>>

where S: Into<MultipleStrings>,

Unsubscribe from a channel on the PubSub interface.

fn psubscribe<S>(&self, patterns: S) -> impl Future<Output = RedisResult<()>>

where S: Into<MultipleStrings>,

Subscribes the client to the given patterns.

fn punsubscribe<S>(&self, patterns: S) -> impl Future<Output = RedisResult<()>>

where S: Into<MultipleStrings>,

Unsubscribes the client from the given patterns, or from all of them if none is given.

fn publish<R, S, V>( &self, channel: S, message: V, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<Str>, V: TryInto<RedisValue>, V::Error: Into<RedisError>,

Publish a message on the PubSub interface, returning the number of clients that received the message.

fn ssubscribe<C>(&self, channels: C) -> impl Future<Output = RedisResult<()>>

where C: Into<MultipleStrings>,

Subscribes the client to the specified shard channels.

fn sunsubscribe<C>(&self, channels: C) -> impl Future<Output = RedisResult<()>>

where C: Into<MultipleStrings>,

Unsubscribes the client from the given shard channels, or from all of them if none is given.

fn spublish<R, S, V>( &self, channel: S, message: V, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<Str>, V: TryInto<RedisValue>, V::Error: Into<RedisError>,

Posts a message to the given shard channel.

fn pubsub_channels<R, S>( &self, pattern: S, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<Str>,

Lists the currently active channels.

fn pubsub_numpat<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Returns the number of unique patterns that are subscribed to by clients.

fn pubsub_numsub<R, S>( &self, channels: S, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<MultipleStrings>,

Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified channels.

fn pubsub_shardchannels<R, S>( &self, pattern: S, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<Str>,

Lists the currently active shard channels.

fn pubsub_shardnumsub<R, S>( &self, channels: S, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, S: Into<MultipleStrings>,

Returns the number of subscribers for the specified shard channels.

impl SentinelInterface for SentinelClient

fn ckquorum<R, N>(&self, name: N) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover.

fn flushconfig<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.

fn failover<R, N>(&self, name: N) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels.

fn get_master_addr_by_name<R, N>( &self, name: N, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Return the ip and port number of the master with that name.

fn info_cache<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Return cached INFO output from masters and replicas.

fn master<R, N>(&self, name: N) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Show the state and info of the specified master.

fn masters<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Show a list of monitored masters and their state.

fn monitor<R, N>( &self, name: N, ip: IpAddr, port: u16, quorum: u32, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Start Sentinel’s monitoring.

fn myid<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

Return the ID of the Sentinel instance.

fn pending_scripts<R>(&self) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

This command returns information about pending scripts.

fn remove<R, N>(&self, name: N) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Stop Sentinel’s monitoring.

fn replicas<R, N>(&self, name: N) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Show a list of replicas for this master, and their state.

fn sentinels<R, N>(&self, name: N) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>,

Show a list of sentinel instances for this master, and their state.

fn set<R, N, V>(&self, name: N, args: V) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, N: Into<Str>, V: TryInto<RedisMap>, V::Error: Into<RedisError>,

Set Sentinel’s monitoring configuration.

fn simulate_failure<R>( &self, kind: SentinelFailureKind, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis,

This command simulates different Sentinel crash scenarios.

fn reset<R, P>(&self, pattern: P) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, P: Into<Str>,

This command will reset all the masters with matching name.

fn config_get<R, K>(&self, name: K) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, K: Into<Str>,

Get the current value of a global Sentinel configuration parameter. The specified name may be a wildcard, similar to the Redis CONFIG GET command.

fn config_set<R, K, V>( &self, name: K, value: V, ) -> impl Future<Output = RedisResult<R>>

where R: FromRedis, K: Into<Str>, V: TryInto<RedisValue>, V::Error: Into<RedisError>,

Set the value of a global Sentinel configuration parameter.