Struct fred::types::ConnectionConfig

pub struct ConnectionConfig {

    pub connection_timeout: Duration,
    pub internal_command_timeout: Duration,
    pub cluster_cache_update_delay: Duration,
    pub max_command_attempts: u32,
    pub max_redirections: u32,
    pub unresponsive: UnresponsiveConfig,
    pub reconnect_on_auth_error: bool,
    pub auto_client_setname: bool,
    pub max_command_buffer_len: usize,
    pub disable_cluster_health_check: bool,
    pub replica: ReplicaConfig,
    pub tcp: TcpConfig,
    pub reconnect_errors: Vec<ReconnectError>,
    pub router_task_queue: Option<TaskQueueHandle>,
    pub connection_task_queue: Option<TaskQueueHandle>,
}

Configuration options related to the creation or management of TCP connection.

Fields

connection_timeout: Duration

The timeout to apply when attempting to create a new TCP connection.

This also includes the TLS handshake if using any of the TLS features.

Default: 10 sec

internal_command_timeout: Duration

The timeout to apply when sending internal commands such as AUTH, SELECT, CLUSTER SLOTS, READONLY, etc.

Default: 10 sec

cluster_cache_update_delay: Duration

The amount of time to wait after a MOVED error is received before the client will update the cached cluster state.

Default: 0

max_command_attempts: u32

The maximum number of times the client will attempt to send a command.

This value be incremented whenever the connection closes while the command is in-flight.

Default: 3

max_redirections: u32

The maximum number of times the client will attempt to follow a MOVED or ASK redirection per command.

Default: 5

unresponsive: UnresponsiveConfig

Unresponsive connection configuration options.

reconnect_on_auth_error: bool

An unexpected NOAUTH error is treated the same as a general connection failure, causing the client to reconnect based on the ReconnectPolicy. This is recommended if callers are using ElastiCache.

Default: false

auto_client_setname: bool

Automatically send CLIENT SETNAME on each connection associated with a client instance.

Default: false

max_command_buffer_len: usize

Limit the size of the internal in-memory command queue.

Commands that exceed this limit will receive a RedisErrorKind::Backpressure error.

See command_queue_len for more information.

Default: 0 (unlimited)

disable_cluster_health_check: bool

Disable the CLUSTER INFO health check when initializing cluster connections.

Default: false

replica: ReplicaConfig

Available on crate feature replicas only.

Configuration options for replica nodes.

Default: None

tcp: TcpConfig

TCP connection options.

reconnect_errors: Vec<ReconnectError>

Available on crate feature custom-reconnect-errors only.

Errors that should trigger reconnection logic.

router_task_queue: Option<TaskQueueHandle>

Available on crate feature glommio only.

The task queue onto which routing tasks will be spawned.

May cause a panic if spawn_local_into fails.

connection_task_queue: Option<TaskQueueHandle>

Available on crate feature glommio only.

The task queue onto which connection reader tasks will be spawned.

May cause a panic if spawn_local_into fails.

Trait Implementations

impl Clone for ConnectionConfig

fn clone(&self) -> ConnectionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionConfig

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

Formats the value using the given formatter.

impl Default for ConnectionConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ConnectionConfig

fn eq(&self, other: &ConnectionConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConnectionConfig

impl StructuralPartialEq for ConnectionConfig