locker

Documentation

Index

• Variables
• type Locker
  • func (locker *Locker) Fetch(flags ingredient.FetcherFlags, info *status.WissKI) (err error)
  • func (lock *Locker) Locked(ctx context.Context) (locked bool)
  • func (lock *Locker) TryLock(ctx context.Context) bool
  • func (lock *Locker) TryUnlock(ctx context.Context) bool
  • func (lock *Locker) Unlock(ctx context.Context)

Variables

var Locked = exit.Error{
	Message:  "instance is locked for administrative operations",
	ExitCode: exit.ExitGeneric,
}

Types

type Locker

type Locker struct {
	ingredient.Base
}

Locker provides facitilites for locking this WissKI instance

func (*Locker) Fetch

func (locker *Locker) Fetch(flags ingredient.FetcherFlags, info *status.WissKI) (err error)

func (*Locker) Locked

func (lock *Locker) Locked(ctx context.Context) (locked bool)

Locked checks if this WissKI is currently locked. If an error occurs, the instance is considered not locked.

func (*Locker) TryLock

func (lock *Locker) TryLock(ctx context.Context) bool

TryLock attemps to lock this WissKI and returns if it suceeded

func (*Locker) TryUnlock

func (lock *Locker) TryUnlock(ctx context.Context) bool

TryUnlock attempts to unlock this WissKI and reports if it succeeded. An Unlock is also attempted when ctx is cancelled.

func (*Locker) Unlock

func (lock *Locker) Unlock(ctx context.Context)

Unlock unlocks this WissKI, ignoring any error.