locks

Documentation

Index

• Constants
• type Locker
  • func KeyLocker(key interface{}) Locker
  • func NopLocker() Locker
• type Unlocker
  • func Lock(key interface{}) Unlocker

Constants

const (
	LOCK operation = iota
	UNLOCK
)

Types

type Locker

type Locker interface {
	Lock() Unlocker
}

func KeyLocker

func KeyLocker(key interface{}) Locker

KeyLocker provides an application-wide locker on the specified key.

func NopLocker

func NopLocker() Locker

NopLocker returns a Locker which always works but does nothing: it's used to effectively skip locking.

type Unlocker

type Unlocker interface {
	Unlock()
}

Unlocker Interface for unlocking a key that was provided to Lock()

func Lock

func Lock(key interface{}) Unlocker

Lock function provides a backwards compatible API for application-wide locking on a key