widelock

README

widelock

A key based lock interface with local (memory) and distributed (consul、etcd) implementation

Documentation

Index

• Variables
• type Mutex
• type MutexSet
• type Option
• type OptionSet

Variables

var (
	ErrAlreadyClosed    = errors.New("widelock: set already closed")
	ErrAlreadyUnlocked  = errors.New("widelock: already unlocked")
	ErrLockNotHeld      = errors.New("widelock: lock not held")
	ErrLockNotSetExpiry = errors.New("widelock: lock not set expiry")
	ErrInvalidDuration  = errors.New("widelock: invalid duration")
)

Types

type Mutex

type Mutex interface {
	Lock(context.Context) error
	TryLock(context.Context) (bool, error)
	Unlock() error
	Extend(context.Context, time.Duration) error
	Valid(context.Context) bool
	Name() string
}

type MutexSet

type MutexSet interface {
	NewMutex(key string, opts ...Option) Mutex
	Close() error
}

type Option

type Option interface {
	Apply(Mutex)
}

type OptionSet

type OptionSet interface {
	Apply(MutexSet)
}