supervisorlock

Documentation

Overview

Package supervisorlock provides exclusive locking for governator supervisors.

Index

• Variables
• func Held(repoRoot string, name string) (bool, error)
• func IsStaleLockError(err error) bool
• func Remove(repoRoot string, name string) error
• type Lock
  • func Acquire(repoRoot string, name string) (*Lock, error)
  • func (lock *Lock) Release() error

Variables

var ErrLockHeld = errors.New("supervisor lock already held")

ErrLockHeld indicates a supervisor lock is already held.

var ErrStaleLock = errors.New("stale supervisor lock")

ErrStaleLock indicates lock metadata references a non-running process.

Functions

func Held

func Held(repoRoot string, name string) (bool, error)

Held reports whether the named supervisor lock is currently held by a live process.

func IsStaleLockError

func IsStaleLockError(err error) bool

IsStaleLockError reports whether the provided error indicates stale lock metadata.

func Remove

func Remove(repoRoot string, name string) error

Remove deletes the named supervisor lock file if it exists.

Types

type Lock

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

Lock holds the acquired supervisor lock file handle.

func Acquire

func Acquire(repoRoot string, name string) (*Lock, error)

Acquire attempts to create and lock the named supervisor lock file for the repo.

func (*Lock) Release

func (lock *Lock) Release() error

Release unlocks and removes the supervisor lock file.