rule

Documentation

Index

• Constants
• type ActionSignal
• type MockCron
  • func (m *MockCron) AddFunc(_ string, cmd func()) (cron.EntryID, error)
  • func (m *MockCron) Remove(id cron.EntryID)
  • func (m *MockCron) Start()
• type RuleState
  • func NewRuleState(rule *def.Rule) (rs *RuleState, err error)
  • func (rs *RuleState) Close() (err error)
  • func (rs *RuleState) GetNextScheduleStartTime() int64
  • func (rs *RuleState) GetScheduleTimestamp() (int64, int64, int64)
  • func (rs *RuleState) GetState() (s string, err error)
  • func (rs *RuleState) GetTopoGraph() *def.PrintableTopo
  • func (rs *RuleState) InternalStop() (err error)
  • func (rs *RuleState) Start() (err error)
  • func (rs *RuleState) Stop() (err error)
  • func (rs *RuleState) UpdateTopo(rule *def.Rule) (err error)

Constants

const (
	RuleStarted    = "Running"
	RuleStopped    = "Stopped: canceled manually."
	RuleTerminated = "Stopped: schedule terminated."
	RuleWait       = "Stopped: waiting for next schedule."
)

Types

type ActionSignal

type ActionSignal int

const (
	ActionSignalStart ActionSignal = iota
	ActionSignalStop
)

type MockCron

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

func (*MockCron) AddFunc

func (m *MockCron) AddFunc(_ string, cmd func()) (cron.EntryID, error)

AddFunc MockCron execute function immediately at once

func (*MockCron) Remove

func (m *MockCron) Remove(id cron.EntryID)

func (*MockCron) Start

func (m *MockCron) Start()

type RuleState

type RuleState struct {
	// Constant, never change. Channel to send signals to manage connection retry. When deleting the rule, close it.
	RuleId   string
	ActionCh chan ActionSignal
	// Nearly constant, only change when update the rule
	Rule *def.Rule
	// States, create through rule in each rule start
	Topology *topo.Topo

	sync.RWMutex
	// contains filtered or unexported fields
}

func NewRuleState

func NewRuleState(rule *def.Rule) (rs *RuleState, err error)

NewRuleState Create and initialize a rule state. Errors are possible during plan the topo. If error happens return immediately without add it to the registry

func (*RuleState) Close

func (rs *RuleState) Close() (err error)

func (*RuleState) GetNextScheduleStartTime

func (rs *RuleState) GetNextScheduleStartTime() int64

func (*RuleState) GetScheduleTimestamp

func (rs *RuleState) GetScheduleTimestamp() (int64, int64, int64)

func (*RuleState) GetState

func (rs *RuleState) GetState() (s string, err error)

func (*RuleState) GetTopoGraph

func (rs *RuleState) GetTopoGraph() *def.PrintableTopo

func (*RuleState) InternalStop

func (rs *RuleState) InternalStop() (err error)

func (*RuleState) Start

func (rs *RuleState) Start() (err error)

func (*RuleState) Stop

func (rs *RuleState) Stop() (err error)

Stop remove the Topology

func (*RuleState) UpdateTopo

func (rs *RuleState) UpdateTopo(rule *def.Rule) (err error)