lock

package

v0.0.0-...-7aa4b52 Latest Latest Go to latest Published: Feb 23, 2022 License: BSD-3-Clause Imports: 6 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

Package lock is a wrapper for file description locks.

This section is empty.

This section is empty.

This section is empty.

type File struct {
	*os.File
	// contains filtered or unexported fields
}

File is a flock() based avisory file lock.

dup()ed file descriptors share the same file description, and so share the same lock.

func Exclusive(file *os.File) *File

Exclusive creates a new exclusive lock.

Returns an unlocked lock.

func OpenLockedExclusive(path string) (*File, error)

OpenLockedExclusive opens the given path and acquires an exclusive lock.

func OpenLockedShared(path string) (*File, error)

OpenShared opens the given path and acquires a shared lock.

func Shared(file *os.File) *File

Shared creates a new shared lock.

The lock is implicitly released when the file description of file is closed.

Returns an unlocked lock.

func (fl *File) Lock()

Lock implements sync.Locker.

It panics if the underlying syscalls return an error.

func (fl *File) TryLock() bool

TryLock attempts to lock the file without blocking.

It panics if the underlying syscalls return an error.

func (fl *File) Unlock()

Unlock implements sync.Locker.

It panics if the underlying syscalls return an error.