Documentation ¶
Index ¶
- type Machine
- type Manager
- func (m *Manager) AddWatcher(w Watcher) error
- func (m *Manager) Delete()
- func (m *Manager) NotifyStateChance()
- func (m *Manager) Run(ctx context.Context, wg *sync.WaitGroup) error
- func (m *Manager) SetMachine(t interface{}) (err error)
- func (m *Manager) WatcherState(watcher string) (interface{}, bool)
- type State
- type Watcher
- type WatcherDef
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Machine ¶
type Machine interface { Name() string State() string Directory() string Transition(t string, args ...interface{}) error NotifyWatcherState(string, interface{}) Watchers() []*WatcherDef Identity() string InstanceID() string Version() string TimeStampSeconds() int64 TextFileDirectory() string OverrideData() ([]byte, error) Debugf(name string, format string, args ...interface{}) Infof(name string, format string, args ...interface{}) Errorf(name string, format string, args ...interface{}) }
Machine is a Choria Machine
type Manager ¶
Manager manages all the defined watchers in a specific machine implements machine.WatcherManager
func (*Manager) AddWatcher ¶
AddWatcher adds a watcher to a managed machine
func (*Manager) Delete ¶ added in v0.15.0
func (m *Manager) Delete()
Delete gets called before a watcher is being deleted after its files were removed from disk
func (*Manager) NotifyStateChance ¶
func (m *Manager) NotifyStateChance()
NotifyStateChance implements machine.WatcherManager
func (*Manager) Run ¶
Run starts all the defined watchers and periodically announce their state based on AnnounceInterval
func (*Manager) SetMachine ¶
SetMachine supplies the machine this manager will manage
func (*Manager) WatcherState ¶ added in v0.17.0
WatcherState retrieves the current status for a given watcher, boolean result is false for unknown watchers
type Watcher ¶
type Watcher interface { Name() string Type() string Run(context.Context, *sync.WaitGroup) NotifyStateChance() CurrentState() interface{} AnnounceInterval() time.Duration Delete() }
Watcher is anything that can be used to watch the system for events
type WatcherDef ¶
type WatcherDef struct { Name string `json:"name" yaml:"name"` Type string `json:"type" yaml:"type"` StateMatch []string `json:"state_match" yaml:"state_match"` FailTransition string `json:"fail_transition" yaml:"fail_transition"` SuccessTransition string `json:"success_transition" yaml:"success_transition"` Interval string `json:"interval" yaml:"interval"` AnnounceInterval string `json:"announce_interval" yaml:"announce_interval"` Properties map[string]interface{} `json:"properties" yaml:"properties"` // contains filtered or unexported fields }
WatcherDef is the core definition of a watcher, watcher type specific properties get stored in Properties and parsed by each watcher type
func (*WatcherDef) ParseAnnounceInterval ¶
func (w *WatcherDef) ParseAnnounceInterval() (err error)
ParseAnnounceInterval parses the announce interval and ensures its not too small
func (*WatcherDef) ValidateStates ¶
func (w *WatcherDef) ValidateStates(valid []string) (err error)
ValidateStates makes sure that all the states mentioned are valid
func (*WatcherDef) ValidateTransitions ¶
func (w *WatcherDef) ValidateTransitions(valid []string) (err error)
ValidateTransitions checks that all stated transitions are valid