dlocker

Documentation

Overview

Package dlocker is a distributed locker for distributed objects whose access requires synchronization. The objects may reside in same process or different processes.

Index

• Variables
• type Locker
  • func NewRedisLocker(ctx context.Context, client *redis.Client, lockID string) Locker

Variables

var (
	// ErrLeaseTimeExceeded happens when lock is held for longer that lease time
	ErrLeaseTimeExceeded = fmt.Errorf("maximum lease time is %d seconds", 10)
	// ErrLockNotHeld happens when calling Release on a locker that is Released
	ErrLockNotHeld = errors.New("lock is released")
)

Types

type Locker

type Locker interface {
	Acquire(context.Context) error
	Release(context.Context) error
	Released() <-chan struct{}
}

Locker is a distributed locker for clients to implement

func NewRedisLocker

func NewRedisLocker(ctx context.Context, client *redis.Client, lockID string) Locker

NewRedisLocker creates a distributed locker using redis pub sub and set data structure