Categorygithub.com/gofrs/flock
modulepackage
0.12.1
Repository: https://github.com/gofrs/flock.git
Documentation: pkg.go.dev

# README

flock

Go Reference License Go Report Card

flock implements a thread-safe file lock.

It also includes a non-blocking TryLock() function to allow locking without blocking execution.

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.

License

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

Project History

This project was originally github.com/theckman/go-flock, it was transferred to Gofrs by the original author Tim Heckman .

# Functions

New returns a new instance of *Flock.
NewFlock returns a new instance of *Flock.
SetFlag sets the flag used to create/open the file.
SetPermissions sets the OS permissions to set on the file.

# Structs

Flock is the struct type to handle file locking.

# Type aliases