flock

Documentation

Index

• Variables
• type FileLocker
  • func NewLocker(filepath string) (*FileLocker, error)
  • func (l *FileLocker) Acquire(timeout time.Duration) error
  • func (l *FileLocker) Release()

Variables

var (
	ErrAcquireLock = errors.New("could not acquire lock")
)

Types

type FileLocker

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

FileLocker is the structure that wraps exclusive file locking functionality.

func NewLocker

func NewLocker(filepath string) (*FileLocker, error)

NewLocker creates new locker instance for a file path.

func (*FileLocker) Acquire

func (l *FileLocker) Acquire(timeout time.Duration) error

Acquire tries to lock the file for writing (exclusive lock) using flock(2). If the function cannot obtain a lock during the timeout it will return an error.

func (*FileLocker) Release

func (l *FileLocker) Release()

Release releases the lock on the file.