flock

README

flock

Documentation

Index

• func Lock(path string) (*os.File, error)
• func LockFile(f *os.File) error
• func TryLock(path string) (*os.File, error)
• func TryLockFile(f *os.File) (bool, error)
• func Unlock(f *os.File) error

Functions

func Lock

func Lock(path string) (*os.File, error)

Lock gets an exclusive lock on the file at the given path. If the file doesn't exist, it's created.

func LockFile

func LockFile(f *os.File) error

func TryLock

func TryLock(path string) (*os.File, error)

TryLock will return a nil file if the file is already locked.

func TryLockFile

func TryLockFile(f *os.File) (bool, error)

Returns true if the lock was successfully acquired.

func Unlock

func Unlock(f *os.File) error

Unlock releases the lock acquired via the Lock function.