filelock

Documentation

Index

• Variables
• type FileLock
  • func Lock(filename string) (*FileLock, error)
  • func (fl *FileLock) Unlock() error

Variables

var ErrLocked = errors.New("specified lockfile is locked")

ErrLocked is returned from Lock if a Lock is called on an existing LockFile

Types

type FileLock

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

FileLock is a handle to an on-disk file lock.

func Lock

func Lock(filename string) (*FileLock, error)

Lock attempts to acquire a lock on the file at `filename`. Returns an error if a lock has already been created.

func (*FileLock) Unlock

func (fl *FileLock) Unlock() error

Unlock unlocks the FileLock.