xredis

Documentation

Index

• func SetLogger(logger Logging)
• type Client
  • func NewClient(config *RedisConfig) (client *Client, err error)
  • func (c *Client) DisableKeyPrefix()
  • func (c *Client) EnableKeyPrefix()
  • func (c *Client) KeyPrefix() string
• type Logging
• type RedisConfig
• type RedisCounter
  • func NewRedisCounter(client *Client, key string, keyFmtArgs ...interface{}) *RedisCounter
  • func (c *RedisCounter) Expire(ctx context.Context, duration time.Duration) error
  • func (c *RedisCounter) Incr(ctx context.Context) int64
• type RedisLocker
  • func NewRedisLocker(client *Client, key string, keyFmtArgs ...interface{}) *RedisLocker
  • func (l *RedisLocker) Key() string
  • func (l *RedisLocker) Lock(ctx context.Context, values ...interface{}) bool
  • func (l *RedisLocker) Unlock(ctx context.Context, values ...interface{}) bool
  • func (l *RedisLocker) WithConfig(retries int, interval, expiration time.Duration) *RedisLocker

Functions

func SetLogger

func SetLogger(logger Logging)

Types

type Client

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

func NewClient

func NewClient(config *RedisConfig) (client *Client, err error)

func (*Client) DisableKeyPrefix

func (c *Client) DisableKeyPrefix()

func (*Client) EnableKeyPrefix

func (c *Client) EnableKeyPrefix()

func (*Client) KeyPrefix

func (c *Client) KeyPrefix() string

type Logging

type Logging interface {
	Printf(ctx context.Context, format string, v ...interface{})
}

type RedisConfig

type RedisConfig struct {
	Addr         string `json:"addr"`
	Password     string `json:"password"`
	DB           int    `json:"DB"`
	DialTimeout  int64  `json:"dialTimeout"`
	ReadTimeout  int64  `json:"readTimeout"`
	WriteTimeout int64  `json:"writeTimeout"`
	IdleTimeout  int64  `json:"idleTimeout"` // 连接生效时间，默认5分钟
	MaxRetries   int    `json:"maxRetries"`
	PoolSize     int    `json:"poolSize"`
	MinIdleConn  int    `json:"minIdleConn"`
	KeyPrefix    string `json:"keyPrefix"`
}

type RedisCounter

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

RedisCounter Redis 计数器

func NewRedisCounter

func NewRedisCounter(client *Client, key string, keyFmtArgs ...interface{}) *RedisCounter

func (*RedisCounter) Expire

func (c *RedisCounter) Expire(ctx context.Context, duration time.Duration) error

func (*RedisCounter) Incr

func (c *RedisCounter) Incr(ctx context.Context) int64

type RedisLocker

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

RedisLocker Redis 锁

func NewRedisLocker

func NewRedisLocker(client *Client, key string, keyFmtArgs ...interface{}) *RedisLocker

func (*RedisLocker) Key

func (l *RedisLocker) Key() string

func (*RedisLocker) Lock

func (l *RedisLocker) Lock(ctx context.Context, values ...interface{}) bool

func (*RedisLocker) Unlock

func (l *RedisLocker) Unlock(ctx context.Context, values ...interface{}) bool

func (*RedisLocker) WithConfig

func (l *RedisLocker) WithConfig(retries int, interval, expiration time.Duration) *RedisLocker