redis

Documentation

Index

• Variables
• type Config
• type Handler
  • func New(c Config) (*Handler, error)
  • func (h *Handler) Get(key string, result interface{}) error
  • func (h *Handler) Ping() error
  • func (h *Handler) Set(key string, value interface{}, expiry time.Duration) error

Variables

var (
	// ErrInvHosts is returned when the provided host(s) is/are invalid
	ErrInvHosts = errors.New("Invalid hosts provided")
	// ErrPing is the error returned in case of ping failure
	ErrPing = errors.New("Ping failed")
)

Types

type Config

type Config struct {
	Hosts           []string
	DB              int
	Password        string
	MaxRetries      int
	MinRetryBackoff time.Duration
	MaxRetryBackoff time.Duration

	DialTimeout  time.Duration
	ReadTimeout  time.Duration
	WriteTimeout time.Duration

	PoolSize           int
	PoolTimeout        time.Duration
	IdleTimeout        time.Duration
	IdleCheckFrequency time.Duration
}

Config struct has all the configurations required for redis

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler struct does all the cache operations

func New

func New(c Config) (*Handler, error)

New returns a handler instance with all the required attributes initialized

func (*Handler) Get

func (h *Handler) Get(key string, result interface{}) error

Get loads the value of the given key, from Redis to result

func (*Handler) Ping

func (h *Handler) Ping() error

Ping pings the redis server

func (*Handler) Set

func (h *Handler) Set(key string, value interface{}, expiry time.Duration) error

Set saves a new value in Redis with the given key, value and expiry