fslock

Documentation

Index

• Variables
• type Locker
  • func Lock(path string) (*Locker, error)
  • func New(path string) *Locker
  • func (l *Locker) Lock() error
  • func (l *Locker) Unlock() error

Variables

var ErrLocked = errors.New("fslock: directory is locked")

ErrLocked is signaled when someone tries to lock an already locked file.

Types

type Locker

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

Locker is a simple utility meant to create lock files. This is to prevent multiple processes from managing the same working directory by purpose or accident. NOTE: Windows is not supported.

func Lock

func Lock(path string) (*Locker, error)

Lock creates a new Locker under the given 'path' and immediately does Lock on it.

func New

func New(path string) *Locker

New creates a new Locker with a File pointing to the given 'path'.

func (*Locker) Lock

func (l *Locker) Lock() error

Lock locks the file. Subsequent calls will error with ErrLocked on any Locker instance looking to the same path.

func (*Locker) Unlock

func (l *Locker) Unlock() error

Unlock frees up the lock.