filelocks

Documentation

Index

• 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

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.

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.

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.