keylock

Documentation

Index

• type ErrInvalidHandle
  • func (e *ErrInvalidHandle) Error() string
• type ErrKeyLockNotFound
  • func (e *ErrKeyLockNotFound) Error() string
• type KeyLock
  • func ByName(klName string) KeyLock
  • func New() KeyLock
• type LockHandle

Types

type ErrInvalidHandle

type ErrInvalidHandle struct {
	// ID unique object identifier.
	ID string
}

ErrInvalidHandle error type for invalid lock handle.

func (*ErrInvalidHandle) Error

func (e *ErrInvalidHandle) Error() string

type ErrKeyLockNotFound

type ErrKeyLockNotFound struct {
	// ID unique object identifier.
	ID string
}

ErrKeyLockNotFound error type for lock object not found

func (*ErrKeyLockNotFound) Error

func (e *ErrKeyLockNotFound) Error() string

type KeyLock

type KeyLock interface {
	// Acquire a lock associated with the specified ID.
	// Creates the lock if one doesn't already exist.
	Acquire(id string) LockHandle

	// Release the lock associated with the specified LockHandle
	// Returns an error if it is an invalid LockHandle.
	Release(h *LockHandle) error

	// Dump all locks.
	Dump() []string
}

KeyLock is a thread-safe interface for acquiring locks on arbitrary strings.

func ByName

func ByName(klName string) KeyLock

ByName creates a new instance or returns an existing instance if found in the map.

func New

func New() KeyLock

New returns a new instance of a KeyLock.

type LockHandle

type LockHandle struct {
	// contains filtered or unexported fields
}

LockHandle is an opaque handle to an acquired lock.