History

CrazyMax 7e560ae76f vendor with go mod Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>		2021-12-16 21:16:01 +01:00
..
.gitignore	vendor with go mod	2021-12-16 21:16:01 +01:00
.travis.yml	vendor with go mod	2021-12-16 21:16:01 +01:00
LICENSE	vendor: github.com/gofrs/flock v0.7.3	2020-10-20 22:46:48 +02:00
README.md	vendor: github.com/gofrs/flock v0.7.3	2020-10-20 22:46:48 +02:00
appveyor.yml	vendor with go mod	2021-12-16 21:16:01 +01:00
flock.go	vendor: github.com/gofrs/flock v0.7.3	2020-10-20 22:46:48 +02:00
flock_unix.go	vendor: github.com/gofrs/flock v0.7.3	2020-10-20 22:46:48 +02:00
flock_winapi.go	vendor: update buildkit to 62e55427	2019-04-02 23:40:56 -07:00
flock_windows.go	vendor: github.com/gofrs/flock v0.7.3	2020-10-20 22:46:48 +02:00

README.md

flock

flock implements a thread-safe sync.Locker interface for file locking. It also includes a non-blocking TryLock() function to allow locking without blocking execution.

License

flock is released under the BSD 3-Clause License. See the LICENSE file for more details.

Go Compatibility

This package makes use of the context package that was introduced in Go 1.7. As such, this package has an implicit dependency on Go 1.7+.

Installation

go get -u github.com/gofrs/flock

Usage

import "github.com/gofrs/flock"

fileLock := flock.New("/var/lock/go-lock.lock")

locked, err := fileLock.TryLock()

if err != nil {
	// handle locking error
}

if locked {
	// do work
	fileLock.Unlock()
}

For more detailed usage information take a look at the package API docs on GoDoc.