lockfile

Documentation

Overview

Package lockfile provides owner-token based local file locking.

Index

• func Configure(next Options)
• type Lock
  • func New(path string) *Lock
  • func (l *Lock) Acquire() error
  • func (l *Lock) Release() error
• type Options

Functions

func Configure

func Configure(next Options)

Configure sets package-level defaults for locks created by New.

Types

type Lock

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

Lock provides owner-token based file locking.

func New

func New(path string) *Lock

New creates a Lock for the given base path.

func (*Lock) Acquire

func (l *Lock) Acquire() error

Acquire attempts to acquire the lock.

func (*Lock) Release

func (l *Lock) Release() error

Release removes the lock only if this process still owns it.

type Options

type Options struct {
	TimeoutEnvVar        string
	DetailedTimeoutError bool
	WarnBelowMinTimeout  bool
	Stderr               io.Writer
}

Options configures lock acquisition behavior.