flock

Documentation

Index

• Variables
• type Lock
  • func New(filename string) Lock

Variables

var ErrLocked error = acquireFailedError("already locked")

ErrLocked indicates TryLock failed because the lock was already locked.

var ErrTimeout error = acquireTimeoutError("acquire timeout exceeded")

ErrTimeout indicates that the lock attempt timed out.

Types

type Lock

type Lock interface {
	Acquire() error
	AcquireWithTimeout(time.Duration) error
	TryAcquire() error
	Release() error
}

Lock implements flock syscall based cross-process locking.

func New

func New(filename string) Lock

New returns a new lock around the given file.