Interface LockMap

lockmap/map.go:14–29

type PromiseMap map[interface{}]Promise

type LockMap interface {
	// Wait returns the Promise for a key.
	// If the Promise is expired, it will be resolved, but this function will return nil
	Wait(key interface{}) Promise

	// WaitOrLock takes the lock, but only if none exists for that key.
	// If the Promise is expired, it will successfully replace it and the previous Promise will be resolved.
	WaitOrLock(key interface{}, ttl time.Duration) (promise Promise, gotLock bool)

	// Release unlocks a key and resolved the previous Promise, if any.
	Release(key interface{})

	// Allows the LockMap to be started and stopped externally
	Tomb() *tomb.Tomb
	Run() error
}

func New(sweepInterval time.Duration, tomb *tomb.Tomb) LockMap {
	return &lockMap{