packer-cn/vendor/github.com/gofrs/flock
Adrien Delorme fbfe31ceaf
update flock + go mod tidy (#9805)
2020-08-24 10:49:43 +02:00
..
.gitignore Use the hashicorp/go-getter to download files 2019-03-13 12:11:58 +01:00
.travis.yml Use the hashicorp/go-getter to download files 2019-03-13 12:11:58 +01:00
LICENSE update flock + go mod tidy (#9805) 2020-08-24 10:49:43 +02:00
README.md replace github.com/gofrs/flock => github.com/azr/flock v0.0.0-20190823144736-958d66434653 2019-09-05 17:03:54 +02:00
appveyor.yml Use the hashicorp/go-getter to download files 2019-03-13 12:11:58 +01:00
flock.go replace github.com/gofrs/flock => github.com/azr/flock v0.0.0-20190823144736-958d66434653 2019-09-05 17:03:54 +02:00
flock_unix.go replace github.com/gofrs/flock => github.com/azr/flock v0.0.0-20190823144736-958d66434653 2019-09-05 17:03:54 +02:00
flock_winapi.go Use the hashicorp/go-getter to download files 2019-03-13 12:11:58 +01:00
flock_windows.go replace github.com/gofrs/flock => github.com/azr/flock v0.0.0-20190823144736-958d66434653 2019-09-05 17:03:54 +02:00

README.md

flock

TravisCI Build Status GoDoc License Go Report Card

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.