golock

README

golock

Cross-platform lockfile library for Go.

Documentation

Index

• Variables
• func Lock(path string) error
• func Unlock(path string) error

Variables

var ErrBusy = errors.New("Locked by other process")

ErrBusy means a different process has locked the file not used for LockWithTimeout

var ErrNotOwner = errors.New("Process does not own lockfile")

ErrNotOwner means there was an attempt to unlock a lockfile that was not owned by the current process

var ErrReadingLockfile = errors.New("Error reading lockfile")

ErrReadlingLockfile means it could not read the pid out of an existing lockfile

var ErrTimeout = errors.New("Timed out")

ErrTimeout means there was a timeout waiting for the lockfile to be available

Functions

func Lock

func Lock(path string) error

Lock will attempt to grab a lock file at path it will wait until it becomes available

func Unlock

func Unlock(path string) error

Unlock will release the lock on a file