filelock

package

v1.1.0 Latest Latest Go to latest Published: Nov 5, 2026 License: MIT Imports: 4 Imported by: 0

Details

Rendered for

View Source

const FileLockPollInterval = 50 * time.Millisecond

FileLockPollInterval is how often to retry acquiring the file lock.

This section is empty.

This section is empty.

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

Locker provides file-based locking with timeout.

func New(lockPath string, timeout time.Duration) *Locker

New creates a Locker for the given lock file path.

func (l *Locker) Acquire() (unlock func() error, err error)

Acquire acquires the file lock and returns an unlock function. The caller must call the unlock function to release the lock.

func (l *Locker) WithLock(fn func() error) (retErr error)

WithLock executes fn while holding the lock.