gtredis

Documentation

Index

• func IncrementMessageID(id string) (string, error)
• func NewRedisClient(options *RedisOptions) *redis.Client
• func RedisPreflightChecks(client redis.UniversalClient) error
• type Redis
  • func NewRedis(c *redis.Client) *Redis
  • func (r *Redis) Lock(key string, ttl int64, options *locker.Options) (*locker.Lock, error)
  • func (Redis) String() string
• type RedisOptions

Functions

func IncrementMessageID

func IncrementMessageID(id string) (string, error)

incrementMessageID takes in a message ID (e.g. 1564886140363-0) and increments the index section (e.g. 1564886140363-1). This is the next valid ID value, and it can be used for paging through messages.

func NewRedisClient

func NewRedisClient(options *RedisOptions) *redis.Client

newRedisClient creates a new Redis client with the given options. If options is nil, it will use default options.

func RedisPreflightChecks

func RedisPreflightChecks(client redis.UniversalClient) error

redisPreflightChecks makes sure the Redis instance backing the *redis.Client offers the functionality we need. Specifically, it also that it can connect to the actual instance and that the instance supports Redis streams (i.e. it's at least v5).

Types

type Redis

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

func NewRedis

func NewRedis(c *redis.Client) *Redis

NewRedis 初始化locker

func (*Redis) Lock

func (r *Redis) Lock(key string, ttl int64, options *locker.Options) (*locker.Lock, error)

func (Redis) String

func (Redis) String() string

type RedisOptions

type RedisOptions = redis.Options

RedisOptions is an alias to redis.Options so that users can this instead of having to import go-redis directly.