filelock

Documentation

Overview

filelock provides a machine wide file lock.

Index

• Constants
• type Lock
  • func NewLock(dir, name string) (*Lock, error)
  • func (lock *Lock) Lock(message string) error
  • func (lock *Lock) Unlock() error

Constants

const (
	// NameRegexp specifies the regular expression used to identify valid lock names.
	NameRegexp = "^[a-z]+[a-z0-9.-]*$"
)

Types

type Lock

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

Lock represents a machine wide file lock.

func NewLock

func NewLock(dir, name string) (*Lock, error)

NewLock returns a new lock with the given name, using the given lock directory, without acquiring it. The lock name must match the regular expression defined by NameRegexp.

func (*Lock) Lock

func (lock *Lock) Lock(message string) error

Lock blocks until it is able to acquire the lock. It is good behaviour to provide a message that is output in debugging information.

func (*Lock) Unlock

func (lock *Lock) Unlock() error

Unlock releases a held lock.