lock

Documentation

Overview

Package lock provides file based cooperative locking.

Package lock currently only works on darwin/linux.

Index

• type File
  • func New(path string) (*File, error)
  • func (f *File) Close() error
  • func (f *File) Lock() error
  • func (f *File) LockShared() error
  • func (f *File) Unlock() error

Types

type File

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

func New

func New(path string) (*File, error)

func (*File) Close

func (f *File) Close() error

Close unlocks and then closes the file, returning any error. The file handle is closed whether or not unlocking fails with an error.

func (*File) Lock

func (f *File) Lock() error

func (*File) LockShared

func (f *File) LockShared() error

func (*File) Unlock

func (f *File) Unlock() error