lock

Documentation

Index

• type Lock
• type Option
  • func WithPrefix(prefix string) Option
  • func WithTTL(ttl time.Duration) Option
• type RedisLock
  • func NewRedisLock(rdb *redis.Client, key string, opts ...Option) *RedisLock
  • func (l *RedisLock) Lock(ctx context.Context) (bool, error)
  • func (l *RedisLock) Unlock(ctx context.Context) (bool, error)

Types

type Lock

type Lock interface {
	Lock(ctx context.Context) (bool, error)
	Unlock(ctx context.Context) (bool, error)
}

Lock define common func

type Option

type Option func(l *RedisLock)

Option RedisLock option

func WithPrefix

func WithPrefix(prefix string) Option

WithPrefix with prefix

func WithTTL

func WithTTL(ttl time.Duration) Option

WithTTL with ttl

type RedisLock

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

RedisLock is a redis lock.

func NewRedisLock

func NewRedisLock(rdb *redis.Client, key string, opts ...Option) *RedisLock

NewRedisLock new a redis lock instance

func (*RedisLock) Lock

func (l *RedisLock) Lock(ctx context.Context) (bool, error)

Lock acquires the lock.

func (*RedisLock) Unlock

func (l *RedisLock) Unlock(ctx context.Context) (bool, error)

Unlock del the lock. NOTE: token 一致才会执行删除，避免误删，这里用了lua脚本进行事务处理