redis_cache

Documentation

Index

• type KV
• type RedisCache
  • func NewRedisCache(opts RedisCacheOpts) (*RedisCache, error)
  • func (r *RedisCache) BatchStore(b []KV)
  • func (r *RedisCache) Close() error
  • func (r *RedisCache) Get(key string) (v []byte, storedTime, expirationTime time.Time)
  • func (r *RedisCache) Len() int
  • func (r *RedisCache) Store(key string, v []byte, storedTime, expirationTime time.Time)
• type RedisCacheOpts
  • func (opts *RedisCacheOpts) Init() error

Types

type KV

type KV struct {
	Key            string
	V              []byte
	StoreTime      time.Time
	ExpirationTime time.Time
}

type RedisCache

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

func NewRedisCache

func NewRedisCache(opts RedisCacheOpts) (*RedisCache, error)

func (*RedisCache) BatchStore

func (r *RedisCache) BatchStore(b []KV)

BatchStore stores a batch of kv into redis via redis pipeline.

func (*RedisCache) Close

func (r *RedisCache) Close() error

Close closes the redis client.

func (*RedisCache) Get

func (r *RedisCache) Get(key string) (v []byte, storedTime, expirationTime time.Time)

func (*RedisCache) Len

func (r *RedisCache) Len() int

func (*RedisCache) Store

func (r *RedisCache) Store(key string, v []byte, storedTime, expirationTime time.Time)

Store stores kv into redis.

type RedisCacheOpts

type RedisCacheOpts struct {
	// Client cannot be nil.
	Client redis.Cmdable

	// ClientCloser closes Client when RedisCache.Close is called.
	// Optional.
	ClientCloser io.Closer

	// ClientTimeout specifies the timeout for read and write operations.
	// Default is 50ms.
	ClientTimeout time.Duration

	// Logger is the *zap.Logger for this RedisCache.
	// A nil Logger will disable logging.
	Logger *zap.Logger
}

func (*RedisCacheOpts) Init

func (opts *RedisCacheOpts) Init() error