lockfile

package

v1.0.23 Latest Latest Go to latest Published: Apr 30, 2026 License: MIT Imports: 8 Imported by: 0

Details

Rendered for

This section is empty.

View Source

var ErrHeld = errors.New("lockfile: lock already held")

ErrHeld signals retryable contention; callers errors.Is to distinguish from real failures.

This section is empty.

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

func ForSubscribe(appID string) (*LockFile, error)

ForSubscribe sanitises appID against path traversal before forming the lock filename.

func New(path string) *LockFile

func (l *LockFile) Path() string

func (l *LockFile) TryLock() error

TryLock acquires an exclusive non-blocking lock; auto-released on process exit.

func (l *LockFile) Unlock() error

Unlock keeps the file on disk to avoid inode-reuse races between unlock and competing open+flock.