alarm

Documentation

Index

• func NewMessage(alarm bool) interface{}
• type Alarm
  • func New(alarmHandler types.Enablable) *Alarm
  • func (d *Alarm) Enabled() bool
  • func (d *Alarm) SetInputChan(c chan interface{})
  • func (d *Alarm) SetPanicChan(c chan interface{})
  • func (d *Alarm) Shutdown()
  • func (d *Alarm) Start()

Functions

func NewMessage

func NewMessage(alarm bool) interface{}

NewMessage creates a new alarm state update message

Types

type Alarm

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

Alarm is the component that manage the external alarm

func New

func New(alarmHandler types.Enablable) *Alarm

New creates a new Alarm component for an types.Enablable

func (*Alarm) Enabled

func (d *Alarm) Enabled() bool

Enabled is true when the alarm is raised, false otherwise

func (*Alarm) SetInputChan

func (d *Alarm) SetInputChan(c chan interface{})

SetInputChan sets the channel where the alarm updates are sent

func (*Alarm) SetPanicChan

func (d *Alarm) SetPanicChan(c chan interface{})

SetPanicChan sets the channel where this component will send the panics

func (*Alarm) Shutdown

func (d *Alarm) Shutdown()

Shutdown sets all the state to down and notify the handlers

func (*Alarm) Start

func (d *Alarm) Start()

Start the event loop of the Alarm component