locker

Documentation

Index

• type Lock
• type Locker
• type RedisLocker
  • func NewRedisLocker(rdb *redis.Client) *RedisLocker
  • func (rl *RedisLocker) Acquire(ctx context.Context, key string, ttl time.Duration, metadata string) (Lock, error)

Types

type Lock

type Lock interface {
	Release(ctx context.Context) error
	Refresh(ctx context.Context, duration time.Duration) error
	Key() string
}

type Locker

type Locker interface {
	Acquire(ctx context.Context, key string, ttl time.Duration, metadata string) (Lock, error)
}

type RedisLocker

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

RedisLocker : Implementation of Locker interface based on redis

func NewRedisLocker

func NewRedisLocker(rdb *redis.Client) *RedisLocker

NewRedisLocker : Returns a new RedisLocker based on supplied client

func (*RedisLocker) Acquire

func (rl *RedisLocker) Acquire(ctx context.Context, key string, ttl time.Duration, metadata string) (Lock, error)

Acquire : Attempts to acquire the redis lock for the key appending __lock: prefix