lockfile

Documentation

Index

• type Lockfile
  • func Acquire(path string) (*Lockfile, error)
  • func CreateAndAcquire(path string, newDirMode os.FileMode) (*Lockfile, error)
  • func (lf Lockfile) Release() error

Types

type Lockfile

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

Lockfile represents an acquired lockfile.

func Acquire

func Acquire(path string) (*Lockfile, error)

Acquire creates the given file path if it doesn't exist and obtains an exclusive lock on it. An error is returned if the lock has been obtained by another process.

func CreateAndAcquire

func CreateAndAcquire(path string, newDirMode os.FileMode) (*Lockfile, error)

CreateAndAcquire creates any non-existing directories needed to create the lock file, then acquires a lock on it

func (Lockfile) Release

func (lf Lockfile) Release() error

Release releases the lock on the file and removes the file.