Interface LockStore

container/concurrent/lockstore/store.go:15–35

LockStore provides a way to synchronize using locks based on keys This is mainly use to provide different levels of granularity to avoid lock contention

// This is mainly use to provide different levels of granularity to avoid
// lock contention
type LockStore interface {
	// Lock locks the mutex that is used for the given key
	Lock(key string)

	// TryLock attempts to acquire the lock given the timeout. Returns
	// true if it successfully acquire the lock. False otherwise
	TryLock(key string, timeout time.Duration) (success bool)

	// Unlock unlocks the mutex that is used for the given key
	Unlock(key string)

	// RLock locks the mutex for read-only that is used for the given key
	RLock(key string)

	// TryRLock attempts to acquire the reader lock given the timeout. Returns
	// true if it successfully acquire the lock. False otherwise
	TryRLock(key string, timeout time.Duration) (success bool)

	// RUnlock unlocks the mutex for read-only that is used for the given key
	RUnlock(key string)
}

// Specifies locking granularity...
// Is it one per key, per few keys, per the whole store