filelocks

Documentation

Index

• Constants
• Variables
• func AcquireReadLock(file string) (*flock.Flock, error)
• func AcquireWriteLock(file string) (*flock.Flock, error)
• func FlockFile(file string) string
• func ReleaseLock(lock *flock.Flock) error
• func SetLockCycleDurationFactor(v int)
• func SetMaxLockCycles(v int)

Constants

const LockFileSuffix = ".flock"

LockFileSuffix to use for lock files

Variables

var (

	// ErrPathEmpty indicates that no path was specified
	ErrPathEmpty = errors.New("lock path is empty")
	// ErrAcquireLockFailed indicates that it was not possible to lock the resource.
	ErrAcquireLockFailed = errors.New("unable to acquire a lock on the file")
)

Functions

func AcquireReadLock

func AcquireReadLock(file string) (*flock.Flock, error)

AcquireReadLock tries to acquire a shared lock to read from the file and returns a lock object or an error accordingly. Call with the file to lock. This function creates .lock file next to it.

func AcquireWriteLock

func AcquireWriteLock(file string) (*flock.Flock, error)

AcquireWriteLock tries to acquire a shared lock to write from the file and returns a lock object or an error accordingly. Call with the file to lock. This function creates an extra .lock file next to it.

func FlockFile

func FlockFile(file string) string

FlockFile returns the flock filename for a given file name it returns an empty string if the input is empty

func ReleaseLock

func ReleaseLock(lock *flock.Flock) error

ReleaseLock releases a lock from a file that was previously created by AcquireReadLock or AcquireWriteLock.

func SetLockCycleDurationFactor

func SetLockCycleDurationFactor(v int)

SetLockCycleDurationFactor configures the factor applied to the timeout allowed during a lock cycle. Subsequent calls to SetLockCycleDurationFactor have no effect

func SetMaxLockCycles

func SetMaxLockCycles(v int)

SetMaxLockCycles configures the maximum amount of lock cycles. Subsequent calls to SetMaxLockCycles have no effect