flock

package

v0.69.0 Latest Latest Go to latest Published: Nov 2, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/colonyops/hive

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package flock takes an exclusive advisory lock on a file, shared between processes of the same user.

Index ¶

Variables
func Lock(ctx context.Context, path string, wait bool) (unlock func() error, err error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrLocked = errors.New("file is locked")

ErrLocked is returned by Lock with wait false when another holder has the lock.

Functions ¶

func Lock ¶

func Lock(ctx context.Context, path string, wait bool) (unlock func() error, err error)

Lock opens or creates path and takes an exclusive lock on it. With wait it retries until the lock frees or ctx ends; without wait it returns ErrLocked at once. The lock ends when unlock runs or the process exits.

Types ¶

This section is empty.

Source Files ¶

View all Source files

flock.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL