converger

Documentation

Overview

Package converger is a facility for reporting the converged state.

Index

• type Converger
  • func NewConverger(timeout int, stateFn func(bool) error) Converger
• type UID

Types

type Converger

type Converger interface {
	Register() UID
	IsConverged(UID) bool         // is the UID converged ?
	SetConverged(UID, bool) error // set the converged state of the UID
	Unregister(UID)
	Start()
	Pause()
	Loop(bool)
	ConvergedTimer(UID) <-chan time.Time
	Status() map[uint64]bool
	Timeout() int                // returns the timeout that this was created with
	SetStateFn(func(bool) error) // sets the stateFn
}

Converger is the general interface for implementing a convergence watcher.

func NewConverger

func NewConverger(timeout int, stateFn func(bool) error) Converger

NewConverger builds a new converger struct.

type UID

type UID interface {
	ID() uint64   // get Id
	Name() string // get a friendly name
	SetName(string)
	IsValid() bool // has Id been initialized ?
	InvalidateID() // set Id to nil
	IsConverged() bool
	SetConverged(bool) error
	Unregister()
	ConvergedTimer() <-chan time.Time
	StartTimer() (func() error, error) // cancellable is the same as StopTimer()
	ResetTimer() error                 // resets counter to zero
	StopTimer() error
}

UID is the interface resources can use to notify with if converged. You'll need to use part of the Converger interface to Register initially too.