Redix.ConnectionError exception (Redix v1.6.0)

Copy Markdown View Source

Error in the connection to Redis.

This exception represents errors in the connection to Redis: for example, request timeouts, disconnections, and similar.

Exception fields

See t/0.

Error reasons

The :reason field can assume a few Redix-specific values:

  • :closed: when the connection to Redis is closed (and Redix is reconnecting) and the user attempts to talk to Redis

  • :disconnected: when the connection drops while a request to Redis is in flight.

  • :timeout: when Redis doesn't reply to the request in time.

  • :health_check_timeout: when the :health_check_interval option is set and an in-flight command goes unanswered for longer than that interval, so Redix closes the connection and reconnects.

  • :no_replica_connection: when a Redix.Cluster command with route: :replica finds no reachable replica for the slot, most often because the cluster wasn't started with read_from_replicas: true.

Summary

Types

t()

The type for this exception struct.

Types

t()

@type t() :: %Redix.ConnectionError{
  __exception__: true,
  reason: atom() | {:wrong_role, binary()}
}

The type for this exception struct.

This exception has the following public fields:

  • :reason - the error reason. It can be one of the Redix-specific reasons described in the "Error reasons" section below, or any error reason returned by functions in the :gen_tcp module (see the :inet.posix/0 type) or :ssl module.