redis

Documentation

Index

• func CacheClient(options ...*Options) (*rediscache.Codec, error)
• func Client(options ...*Options) (*redis.Client, error)
• func Sync(addr, password string) *redsync.Redsync
• type Options
  • func NewRedisOption() *Options
  • func (o *Options) SetDB(db int) *Options
  • func (o *Options) SetHost(add string) *Options
  • func (o *Options) SetPoolSize(size int) *Options
  • func (o *Options) SetPort(port string) *Options
  • func (o *Options) SetPwd(pwd string) *Options

Functions

func CacheClient

func CacheClient(options ...*Options) (*rediscache.Codec, error)

CacheClient is a redis client

func Client

func Client(options ...*Options) (*redis.Client, error)

func Sync

func Sync(addr, password string) *redsync.Redsync

Types

type Options

type Options struct {
	// The network type, either tcp or unix.
	// Default is tcp.
	Network string
	// host:port address.
	Host string
	Port string
	// Dialer creates new network connection and has priority over
	// Network and Addr options.
	Dialer func() (net.Conn, error)

	// Hook that is called when new connection is established.
	OnConnect func(*redis.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. Use value -1 for no timeout and 0 for default.
	// 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
	// Minimum number of idle connections which is useful when establishing
	// new connection is slow.
	MinIdleConns int
	// Connection age at which client retires (closes) the connection.
	// Default is to not close aged connections.
	MaxConnAge time.Duration
	// 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. -1 disables idle timeout check.
	IdleTimeout time.Duration
	// Frequency of idle checks made by idle connections reaper.
	// Default is 1 minute. -1 disables idle connections reaper,
	// but idle connections are still discarded by the client
	// if IdleTimeout is set.
	IdleCheckFrequency time.Duration

	// TLS Config to use. When set TLS will be negotiated.
	TLSConfig *tls.Config
	// contains filtered or unexported fields
}

func NewRedisOption

func NewRedisOption() *Options

func (*Options) SetDB

func (o *Options) SetDB(db int) *Options

func (*Options) SetHost

func (o *Options) SetHost(add string) *Options

func (*Options) SetPoolSize

func (o *Options) SetPoolSize(size int) *Options

func (*Options) SetPort

func (o *Options) SetPort(port string) *Options

func (*Options) SetPwd

func (o *Options) SetPwd(pwd string) *Options