locking

Documentation

Overview

Package locking contains file- and network (port) locking primitives

Index

• Variables
• type DirLock
  • func NewDirLock(path string) (DirLock, error)
  • func (lock DirLock) Lock() error
  • func (lock DirLock) TryLock() (bool, error)
  • func (lock DirLock) Unlock() error
• type FLock
  • func NewFLock(path string) (*FLock, error)
  • func (lock *FLock) Lock() error
  • func (lock FLock) TryLock() (bool, error)
  • func (lock *FLock) Unlock() error
• type FLocks
  • func FLockDirs(dirs ...string) (FLocks, error)
  • func (locks FLocks) Unlock()
• type PortLock
  • func NewPortLock(port int) *PortLock
  • func (p *PortLock) Lock() error
  • func (p *PortLock) TryLock() (bool, error)
  • func (p *PortLock) Unlock() error

Variables

var AlreadyLocked = errors.New("AlreadyLocked")

AlreadyLocked is an error

Types

type DirLock

type DirLock string

DirLock is a directory lock

func NewDirLock

func NewDirLock(path string) (DirLock, error)

NewDirLock create new directory-based lock (creates a subdir, if not exists, but unlocked first) WARNING: no automatic Unlock on exit/panic!

func (DirLock) Lock

func (lock DirLock) Lock() error

Lock locks (creates .lock subdir)

func (DirLock) TryLock

func (lock DirLock) TryLock() (bool, error)

TryLock acquires the lock, non-blocking

func (DirLock) Unlock

func (lock DirLock) Unlock() error

Unlock releases the directory lock

type FLock

type FLock struct {
	sync.Mutex
	// contains filtered or unexported fields
}

FLock is a file-based lock

func NewFLock

func NewFLock(path string) (*FLock, error)

NewFLock creates new Flock-based lock (unlocked first)

func (*FLock) Lock

func (lock *FLock) Lock() error

Lock acquires the lock, blocking

func (FLock) TryLock

func (lock FLock) TryLock() (bool, error)

TryLock acquires the lock, non-blocking

func (*FLock) Unlock

func (lock *FLock) Unlock() error

Unlock releases the lock

type FLocks

type FLocks []*FLock

FLocks is an array of FLocks, Unlockable at once

func FLockDirs

func FLockDirs(dirs ...string) (FLocks, error)

FLockDirs returns FLocks for each directory

func (FLocks) Unlock

func (locks FLocks) Unlock()

Unlock all locks

type PortLock

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

PortLock is a locker which locks by binding to a port on the loopback IPv4 interface

func NewPortLock

func NewPortLock(port int) *PortLock

NewPortLock returns a lock for port

func (*PortLock) Lock

func (p *PortLock) Lock() error

Lock locks on port

func (*PortLock) TryLock

func (p *PortLock) TryLock() (bool, error)

TryLock acquires the lock, non-blocking

func (*PortLock) Unlock

func (p *PortLock) Unlock() error

Unlock unlocks the port lock