redislock

Documentation

Index

• type RedisLock
  • func New(cli redislock.RedisClient, key string, waitTimeout, lockTTL time.Duration) (*RedisLock, error)
  • func (r *RedisLock) Lock(ctx context.Context) (context.Context, error)
  • func (r *RedisLock) TryLock(ctx context.Context) (context.Context, error)
  • func (r *RedisLock) Unlock(ctx context.Context) error

Types

type RedisLock

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

RedisLock is a redis SET NX based lock

func New

func New(cli redislock.RedisClient, key string, waitTimeout, lockTTL time.Duration) (*RedisLock, error)

New creates a lock key: name of the lock waitTimeout: timeout before getting the lock, Lock returns error if the lock is not acquired after this time lockTTL: ttl of lock, after this time, lock will be released automatically

func (*RedisLock) Lock

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

Lock acquires the lock will try waitTimeout time before getting the lock

func (*RedisLock) TryLock

func (r *RedisLock) TryLock(ctx context.Context) (context.Context, error)

TryLock tries to lock returns error if the lock is already acquired by someone else will not retry to get lock

func (*RedisLock) Unlock

func (r *RedisLock) Unlock(ctx context.Context) error

Unlock releases the lock if the lock is not acquired, will return ErrLockNotHeld