ticker

Documentation

Index

• Constants
• type Component
  • func (t *Component) GetInfo() module.ComponentInfo
  • func (t *Component) Handle(ctx context.Context, handler module.Handler, port string, msg interface{}) error
  • func (t *Component) Instance() module.Component
  • func (t *Component) Ports() []module.Port
• type Context
• type Settings
• type StartControl
• type StopControl

Constants

const (
	ComponentName        = "ticker"
	OutPort       string = "out"
)

Types

type Component

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

func (*Component) GetInfo

func (t *Component) GetInfo() module.ComponentInfo

func (*Component) Handle

func (t *Component) Handle(ctx context.Context, handler module.Handler, port string, msg interface{}) error

func (*Component) Instance

func (t *Component) Instance() module.Component

func (*Component) Ports

func (t *Component) Ports() []module.Port

type Context

type Context any

type Settings

type Settings struct {
	Context Context `json:"context,omitempty" configurable:"true" title:"Context" description:"Arbitrary message to be send each period of time"`
	Delay   int     `json:"delay" required:"true" title:"Delay (ms)" description:"Delay between signals" minimum:"0" default:"1000"`
	Auto    bool    `json:"auto" title:"Auto send" required:"true" description:"Start sending as soon as component configured"`
}

type StartControl

type StartControl struct {
	Context Context `json:"context" required:"true" title:"Context"`
	Status  string  `json:"status" title:"Status" readonly:"true"`
	Start   bool    `json:"start" format:"button" title:"Start" required:"true"`
}

type StopControl

type StopControl struct {
	Context Context `json:"context" required:"true" title:"Context"`
	Status  string  `json:"status" title:"Status" readonly:"true"`
	Stop    bool    `json:"stop" format:"button" title:"Stop" required:"true"`
}