filelock

Documentation

Overview

Package filelock provides portable file locking.

Index

• type Releaser
  • func New(fileName string) (r Releaser, existed bool, err error)

Types

type Releaser

type Releaser interface {
	Release() error
}

Releaser provides the Release method to release a file lock.

func New

func New(fileName string) (r Releaser, existed bool, err error)

New locks the file with the provided name. If the file does not exist, it is created. The returned Releaser is used to release the lock. existed is true if the file to lock already existed. A non-nil error is returned if the locking has failed. Neither this function nor the returned Releaser is goroutine-safe.