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 Control
• type Settings
• type Status

Constants

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

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 Control

type Control struct {
	Start bool `json:"start" required:"true" title:"Component state"`
}

type Settings

type Settings struct {
	Context          Context `json:"context,omitempty" configurable:"true" title:"Context" description:"Arbitrary message to be send each period of time"`
	Period           int     `json:"period" required:"true" title:"Periodicity (ms)" minimum:"10" default:"1000"`
	EnableStatusPort bool    `json:"enableStatusPort" required:"true" title:"Enable status port" description:"Status port"`
}

type Status

type Status struct {
	Status string `json:"status" readonly:"true" title:"Status" colSpan:"col-span-6"`
	Reset  bool   `json:"reset" format:"button" title:"Reset" required:"true" colSpan:"col-span-6"`
}