redislock

Documentation

Index

• Variables
• type Client
  • func New(addr, password string) Client
• type Locker

Variables

var (
	// ErrNotObtained is returned when a lock cannot be obtained.
	ErrNotObtained = redislock.ErrNotObtained

	// ErrLockNotHeld is returned when trying to release an inactive lock.
	ErrLockNotHeld = redislock.ErrLockNotHeld
)

Types

type Client

type Client interface {
	Obtain(key string, ttl time.Duration) (Locker, error)
}

func New

func New(addr, password string) Client

type Locker

type Locker interface {
	Key() string
	TTL() (time.Duration, error)
	Refresh(ttl time.Duration) error
	Release() error
}