lock

package

v1.3.1 Latest Latest Go to latest Published: Apr 24, 2024 License: BSD-3-Clause 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

This section is empty.

View Source

var ErrByteRangeAcquired = errors.New("file byte-range lock is already acquired")

ErrByteRangeAcquired corresponds to the error returned when a file byte-range is already acquired.

View Source

var ErrLockNotSupported = errors.New("file lock is not supported")

ErrLockNotSupported corresponds to the error returned when file locking is not supported.

func Exclusive(path string) (fd int, err error)

Exclusive applies an exclusive lock on path

func Release(fd int) error

Release removes a lock on path referenced by fd

func TryExclusive(path string) (fd int, accquired bool, err error)

TryExclusive applies an exclusive non-blocking lock on path

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

ByteRange defines a file byte-range lock.

func NewByteRange(fd int, start, len int64) *ByteRange

NewByteRange returns a file byte-range lock.

func (r *ByteRange) Lock() error

Lock places a write lock for the corresponding byte-range.

func (r *ByteRange) Lockw() error

Lock places a write lock and waits for the corresponding byte-range.

func (r *ByteRange) RLock() error

RLock places a read lock for the corresponding byte-range.

func (r *ByteRange) RLockw() error

RLock places a read lock and waits for the corresponding byte-range.

func (r *ByteRange) Unlock() error

Unlock removes the lock for the corresponding byte-range.