Documentation
¶
Index ¶
- func NewRedisClusterStore(opts *ClusterOptions, prefix ...string) session.ManagerStore
- func NewRedisClusterStoreWithCli(cli *redis.ClusterClient, prefix ...string) session.ManagerStore
- func NewRedisStore(opts *Options, prefix ...string) session.ManagerStore
- func NewRedisStoreWithCli(cli *redis.Client, prefix ...string) session.ManagerStore
- type ClusterOptions
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewRedisClusterStore ¶
func NewRedisClusterStore(opts *ClusterOptions, prefix ...string) session.ManagerStore
NewRedisClusterStore create an instance of a redis cluster store
func NewRedisClusterStoreWithCli ¶
func NewRedisClusterStoreWithCli(cli *redis.ClusterClient, prefix ...string) session.ManagerStore
NewRedisClusterStoreWithCli create an instance of a redis cluster store
func NewRedisStore ¶
func NewRedisStore(opts *Options, prefix ...string) session.ManagerStore
NewRedisStore create an instance of a redis store
func NewRedisStoreWithCli ¶
func NewRedisStoreWithCli(cli *redis.Client, prefix ...string) session.ManagerStore
NewRedisStoreWithCli create an instance of a redis store
Types ¶
type ClusterOptions ¶
type ClusterOptions struct {
// A seed list of host:port addresses of cluster nodes.
Addrs []string
// The maximum number of retries before giving up. Command is retried
// on network errors and MOVED/ASK redirects.
// Default is 8.
MaxRedirects int
// Enables read-only commands on slave nodes.
ReadOnly bool
// Allows routing read-only commands to the closest master or slave node.
RouteByLatency bool
// Allows routing read-only commands to the random master or slave node.
RouteRandomly bool
OnConnect func(ctx context.Context, cn *redis.Conn) error
MaxRetries int
MinRetryBackoff time.Duration
MaxRetryBackoff time.Duration
Password string
DialTimeout time.Duration
ReadTimeout time.Duration
WriteTimeout time.Duration
// PoolSize applies per cluster node and not for the whole cluster.
PoolSize int
PoolTimeout time.Duration
IdleTimeout time.Duration
IdleCheckFrequency time.Duration
}
ClusterOptions are used to configure a cluster client and should be passed to NewClusterClient.
type Options ¶
type Options struct {
// The network type, either tcp or unix.
// Default is tcp.
Network string
// host:port address.
Addr string
// Dialer creates new network connection and has priority over
// Network and Addr options.
Dialer func(ctx context.Context, network, addr string) (net.Conn, error)
// Optional password. Must match the password specified in the
// requirepass server configuration option.
Password string
// Database to be selected after connecting to the server.
DB int
// Maximum number of retries before giving up.
// Default is to not retry failed commands.
MaxRetries int
// Minimum backoff between each retry.
// Default is 8 milliseconds; -1 disables backoff.
MinRetryBackoff time.Duration
// Maximum backoff between each retry.
// Default is 512 milliseconds; -1 disables backoff.
MaxRetryBackoff time.Duration
// Dial timeout for establishing new connections.
// Default is 5 seconds.
DialTimeout time.Duration
// Timeout for socket reads. If reached, commands will fail
// with a timeout instead of blocking.
// Default is 3 seconds.
ReadTimeout time.Duration
// Timeout for socket writes. If reached, commands will fail
// with a timeout instead of blocking.
// Default is ReadTimeout.
WriteTimeout time.Duration
// Maximum number of socket connections.
// Default is 10 connections per every CPU as reported by runtime.NumCPU.
PoolSize int
// Amount of time client waits for connection if all connections
// are busy before returning an error.
// Default is ReadTimeout + 1 second.
PoolTimeout time.Duration
// Amount of time after which client closes idle connections.
// Should be less than server's timeout.
// Default is 5 minutes.
ConnMaxIdleTime time.Duration
// TLS Config to use. When set TLS will be negotiated.
TLSConfig *tls.Config
}
Options Redis parameter options
Click to show internal directories.
Click to hide internal directories.