lock

Documentation

Overview

Package lock contains the resources required to create a lock.

Index

• Variables
• type Locker

Variables

var (
	// ErrLockNotObtained is returned when a lock cannot be returned.
	ErrLockNotObtained error = errors.New("the lock could not be obtained")
	// ErrUnableToUnlock is returned when a lock cannot be released.
	ErrUnableToUnlock error = errors.New("the lock could not be released")
)

Types

type Locker

type Locker interface {
	// Creates a new lock using an existing lock instance
	NewLock(key string) (Locker, error)

	// Releases the lock
	// Otherwise returns ErrorUnableToUnlock.
	Unlock() error

	// Attempts to acquire lock. If successful, returns the true.
	// Otherwise returns false, ErrorLockNotObtained.
	TryLock() (bool, error)
}

Locker is the abstract interface for providing a lock client that stores data in the lock The data can be used to provide information about the application using the lock including the prior lock client version.