mutexes

type Cond ¶ added in v1.4.0

type Cond struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Cond is similar to a sync.Cond{}, but it encompasses the Mutex{} within itself.

func (c *Cond) Broadcast()

func (c *Cond) Signal()

func (c *Cond) Wait()

type Mutex ¶

type Mutex interface {
	// Lock performs a mutex lock, returning an unlock function
	Lock() (unlock func())
}

Mutex defines a wrappable mutex. By forcing unlocks via returned function it makes wrapping much easier

func New() Mutex

func WithFunc(mu Mutex, onLock, onUnlock func()) Mutex

func WithSafety(mu Mutex) Mutex

type MutexMap ¶

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

MutexMap is a structure that allows read / write locking per key, performing as you'd expect a map[string]*RWMutex to perform, without you needing to worry about deadlocks between competing read / write locks and the map's own mutex. It uses memory pooling for the internal "mutex" (ish) types and performs self-eviction of keys.

Under the hood this is achieved using a single mutex for the map, state tracking for individual keys, and some sync.Cond{} like structures for sleeping / awaking awaiting goroutines.

func (mm *MutexMap) Lock(key string) func()

func (mm *MutexMap) RLock(key string) func()

type RWCond ¶ added in v1.4.0

type RWCond struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

RWCond is similar to a sync.Cond{}, but it encompasses the RWMutex{} within itself.

func (c *RWCond) Broadcast()

func (c *RWCond) Signal()

func (c *RWCond) Wait()

type RWMutex ¶

type RWMutex interface {
	Mutex

	// RLock performs a mutex read lock, returning an unlock function
	RLock() (runlock func())
}

RWMutex defines a wrappable read-write mutex. By forcing unlocks via returned functions it makes wrapping much easier

func NewRW() RWMutex

func WithFuncRW(mu RWMutex, onLock, onRLock, onUnlock, onRUnlock func()) RWMutex

func WithSafetyRW(mu RWMutex) RWMutex

type TimeoutMutex ¶

type TimeoutMutex interface {
	Mutex

	// LockFunc is functionally the same as Lock(), but allows setting a custom hook called on timeout
	LockFunc(func()) func()
}

TimeoutMutex defines a Mutex with timeouts on locks

func WithTimeout(mu Mutex, d time.Duration) TimeoutMutex

type TimeoutRWMutex ¶

type TimeoutRWMutex interface {
	RWMutex

	// LockFunc is functionally the same as Lock(), but allows setting a custom hook called on timeout
	LockFunc(func()) func()

	// RLockFunc is functionally the same as RLock(), but allows setting a custom hook called on timeout
	RLockFunc(func()) func()
}

TimeoutRWMutex defines a RWMutex with timeouts on locks

func WithTimeoutRW(mu RWMutex, rd, wd time.Duration) TimeoutRWMutex