You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Tonis Tiigi 2d720a1e0b vendor: update buildkit with typed errors support Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>		4 years ago
..
.gitignore	vendor: add buildkit	6 years ago
.travis.yml	vendor: add buildkit	6 years ago
LICENSE	vendor: update buildkit with typed errors support	4 years ago
README.md	vendor: github.com/gofrs/flock v0.7.3	4 years ago
appveyor.yml	vendor: add buildkit	6 years ago
flock.go	vendor: github.com/gofrs/flock v0.7.3	4 years ago
flock_unix.go	vendor: github.com/gofrs/flock v0.7.3	4 years ago
flock_winapi.go	vendor: add buildkit	6 years ago
flock_windows.go	vendor: github.com/gofrs/flock v0.7.3	4 years ago

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.