redisboot

Documentation

Index

• type Redis
  • func (s *Redis) Close() error
  • func (s *Redis) Configure(env *goboot.AppEnv) error
  • func (s *Redis) Init() error
  • func (s *Redis) Name() string
• type RedisConfig

Types

type Redis

type Redis struct {
	Client *redis.Client
	// contains filtered or unexported fields
}

Redis implements the AppService interface.

func (*Redis) Close

func (s *Redis) Close() error

Close is run right before shutdown. The app waits until close resolves.

func (*Redis) Configure

func (s *Redis) Configure(env *goboot.AppEnv) error

func (*Redis) Init

func (s *Redis) Init() error

Init implements the AppService interface.

func (*Redis) Name

func (s *Redis) Name() string

type RedisConfig

type RedisConfig struct {
	// Url contains hostname:port, e.g. localhost:6379
	URL string `yaml:"url"`

	// Password if left empty uses no empty
	Password string `yaml:"password"`

	// DB defaults to db 0
	DB int `yaml:"db"`

	// Maximum number of socket connections.
	// Default is 10 connections per every CPU as reported by runtime.NumCPU.
	PoolSize int `yaml:"poolSize"`

	// Dial timeout for establishing new connections. Default is 5 seconds.
	DialTimeout time.Duration `yaml:"dialTimeout"`

	// Number of retries upon initial connect. Default is 5 times. Set -1 to disable
	ConnectMaxRetries int `yaml:"connectMaxRetries"`

	// Time between retries for initial connect attempts. Default is 5 seconds.
	ConnectRetryDuration time.Duration `yaml:"connectRetryDuration"`
}