61a2b7ac94
full diff: https://github.com/gofrs/flock/compare/v0.7.0...v0.7.1 - gofrs/flock#34 don't mention sync.Locker in package documentation - fixes gofrs/flock#33 incorrect interface - gofrs/flock#35 Fix linting issues and add goreportcard badge Signed-off-by: Sebastiaan van Stijn <github@gone.nl> |
||
|---|---|---|
| .. | ||
| LICENSE | ||
| README.md | ||
| flock.go | ||
| flock_unix.go | ||
| flock_winapi.go | ||
| flock_windows.go | ||
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.