locks

Documentation

Index

• Constants
• type Unlocker
  • func Lock(key string) Unlocker

Constants

const (
	LOCK operation = iota
	UNLOCK
)

Types

type Unlocker

type Unlocker interface {
	Unlock()
}

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

func Lock

func Lock(key string) Unlocker

Provides an application-wide lock on the provided key. If the lock is obtained, it will return an Unlocker. If the lock is not successfully obtained, nil will be returned.