redislock

README

redis-lock

Base on https://redis.io/topics/distlock

Features

• Support multiple redis instance

Installation

go get -u github.com/teambition/redis-lock

Licenses

All source code is licensed under the MIT License.

Documentation

Index

• Variables
• type Lock
  • func (l *Lock) Unlock()
• type Locker
  • func NewLocker(clients []redis.Cmdable, opts Options) (*Locker, error)
  • func (l *Locker) Lock(key string) (*Lock, error)
  • func (l *Locker) LockWithExpiration(key string, expiration time.Duration) (*Lock, error)
• type Options

Variables

var (
	ErrGetLockFailed = errors.New("get lock failed")
	ErrGetNewLock    = errors.New("please use Locker to get lock")
	ErrNoRedisClient = errors.New("no redis clients")
	ErrMustBeOdd     = errors.New("the redis count must be odd")
)

Types

type Lock

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

Lock ...

func (*Lock) Unlock

func (l *Lock) Unlock()

Unlock the lock

type Locker

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

Locker ...

func NewLocker

func NewLocker(clients []redis.Cmdable, opts Options) (*Locker, error)

NewLocker ...

func (*Locker) Lock

func (l *Locker) Lock(key string) (*Lock, error)

Lock lock

func (*Locker) LockWithExpiration

func (l *Locker) LockWithExpiration(key string, expiration time.Duration) (*Lock, error)

LockWithExpiration lock

type Options

type Options struct {
	KeyPrefix string
	// The maximum duration to lock a key, Default: 10s
	LockTimeout time.Duration
	// The maximum duration to wait to get the lock, Default: 0s, do not wait
	WaitTimeout time.Duration
	// The maximum wait retry time to get the lock again, Default: 100ms
	WaitRetry time.Duration
}

Options ...