flock

README

Go flock(2) sync.Locker

This is a simple implementation of the sync.Locker interface backed by the flock(2) syscall.

I wouldn't recommend using this in production, but it can be handy if you need a quick inter process lock to prevent concurrent access to shared resources in tests.

Usage

l := flock.NewPath("/tmp/mylock.lock")
l.Lock()
defer l.Unlock()

Documentation

Index

• type Lock
  • func New(f *os.File) *Lock
  • func NewPath(path string) (*Lock, error)
  • func (l *Lock) Lock()
  • func (l *Lock) Unlock()

Types

type Lock

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

Lock is an implementation of the sync.Locker interface that is backed by a file flock(2).

func New

func New(f *os.File) *Lock

New returns a new Lock instance using the provided file as the backend.

func NewPath

func NewPath(path string) (*Lock, error)

NewPath first creates the file at the given path, then returns a new Lock instance backed by the file.

func (*Lock) Lock

func (l *Lock) Lock()

Lock aquires a lock on the file using flock(2). Lock will block if the file was previously locked.

func (*Lock) Unlock

func (l *Lock) Unlock()

Unlock removes the lock on the file using flock(2).