lockfile

Documentation

Index

• Variables
• type LockFile
  • func New(file string) (*LockFile, error)
  • func (lf *LockFile) Lock() (int, error)
  • func (lf *LockFile) Unlock() error

Variables

var (
	// ErrLocked ...
	ErrLocked = errors.New("already locked by another process")
	// ErrAlreadyLocked ...
	ErrAlreadyLocked = errors.New("the lockfile is already locked")
	// ErrAlreadyUnlocked ...
	ErrAlreadyUnlocked = errors.New("already unlocked")
	// ErrInvalidPID ...
	ErrInvalidPID = errors.New("invalid pid")
)

Types

type LockFile

type LockFile struct {
	File string
	// contains filtered or unexported fields
}

LockFile ...

func New

func New(file string) (*LockFile, error)

New Creates a new lockfile.

func (*LockFile) Lock

func (lf *LockFile) Lock() (int, error)

Lock attempts to lock the lockfile. If the lockfile was already locked by this process, it returns ErrAlreadyLocked. Otherwise it typically returns ErrLocked if already locked by another process, and nil if not locked.

func (*LockFile) Unlock

func (lf *LockFile) Unlock() error

Unlock LockFile.Unlock unlocks the lockfile. If the lockfile was not locked it returns ErrAlreadyUnlocked. Unlock will delete the lockfile if it is not already unlocked.