redis

Documentation

Index

• Variables
• func GetRedisClient(conf *RedisConfig) (redis.UniversalClient, error)
• type RedisConfig
  • func (r *RedisConfig) GetMaxRedirects() int
  • func (r *RedisConfig) IsConfigured() bool

Variables

var ErrNotConfigured = errors.New("redis is not configured")

Functions

func GetRedisClient

func GetRedisClient(conf *RedisConfig) (redis.UniversalClient, error)

Types

type RedisConfig

type RedisConfig struct {
	Address  string `yaml:"address,omitempty"`
	Username string `yaml:"username,omitempty"`
	Password string `yaml:"password,omitempty"`
	DB       int    `yaml:"db,omitempty"`
	// Deprecated: use TLS instead of UseTLS
	UseTLS            bool         `yaml:"use_tls,omitempty"`
	TLS               *xtls.Config `yaml:"tls,omitempty"`
	MasterName        string       `yaml:"sentinel_master_name,omitempty"`
	SentinelUsername  string       `yaml:"sentinel_username,omitempty"`
	SentinelPassword  string       `yaml:"sentinel_password,omitempty"`
	SentinelAddresses []string     `yaml:"sentinel_addresses,omitempty"`
	ClusterAddresses  []string     `yaml:"cluster_addresses,omitempty"`
	DialTimeout       int          `yaml:"dial_timeout,omitempty"`
	ReadTimeout       int          `yaml:"read_timeout,omitempty"`
	WriteTimeout      int          `yaml:"write_timeout,omitempty"`
	// for clustererd mode only, number of redirects to follow, defaults to 2
	MaxRedirects *int          `yaml:"max_redirects,omitempty"`
	PoolTimeout  time.Duration `yaml:"pool_timeout,omitempty"`
	PoolSize     int           `yaml:"pool_size,omitempty"`
}

func (*RedisConfig) GetMaxRedirects

func (r *RedisConfig) GetMaxRedirects() int

func (*RedisConfig) IsConfigured

func (r *RedisConfig) IsConfigured() bool