flock

package

v1.2.1 Latest Latest Go to latest Published: Jun 18, 2023 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/0xef53/kvmrun

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type FileLocker
- func NewLocker(filepath string) (*FileLocker, error)
- func (l *FileLocker) Acquire(timeout time.Duration) error
- func (l *FileLocker) Release()

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrAcquireLock = errors.New("could not acquire lock")
)

Functions ¶

This section is empty.

Types ¶

type FileLocker ¶

type FileLocker struct {
	// contains filtered or unexported fields
}

FileLocker is the structure that wraps exclusive file locking functionality.

func NewLocker ¶

func NewLocker(filepath string) (*FileLocker, error)

NewLocker creates new locker instance for a file path.

func (*FileLocker) Acquire ¶

func (l *FileLocker) Acquire(timeout time.Duration) error

Acquire tries to lock the file for writing (exclusive lock) using flock(2). If the function cannot obtain a lock during the timeout it will return an error.

func (*FileLocker) Release ¶

func (l *FileLocker) Release()

Release releases the lock on the file.

Source Files ¶

View all Source files

flock.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL