golock

README

Distributed Lock for Golang

Documentation

Index

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

Variables

var ErrTimeout = errors.New("lock timeout")

ErrTimeout indicates timeout when lock

Types

type Locker

type Locker interface {
	// Lock supports lock a key
	Lock(key string, expiration, timeout time.Duration) error

	// Unlock supports release a key
	Unlock(key string) error
}

Locker represents the abstract of locker

func NewRedisLocker

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

NewRedisLocker returns a new redis locker