scheduler

Documentation

Index

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

Constants

const (
	ComponentName        = "scheduler"
	OutPort       string = "out"
	InPort        string = "in"
	StartPort     string = "start"
	AckPort       string = "ack"
	StopPort      string = "stop"
)

Types

type Component

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

func (*Component) GetInfo

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

func (*Component) Handle

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

func (*Component) Instance

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

func (*Component) Ports

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

type Context

type Context any

type InMessage

type InMessage struct {
	Context Context `json:"context" title:"Context" configurable:"true" description:"Arbitrary message to be send further"`
	Task    Task    `json:"task" title:"Task" required:"true"`
}

type OutMessage

type OutMessage struct {
	Task    Task    `json:"task"`
	Context Context `json:"context"`
}

type Settings

type Settings struct {
	EnableAckPort  bool `` /* 134-byte string literal not displayed */
	EnableStopPort bool `json:"enableStopPort" required:"true" title:"Enable stop port" description:"Stop port allows you to stop scheduler"`
}

type Start

type Start struct {
}

type StartControl

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

type Stop

type Stop struct {
}

type StopControl

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

type Task

type Task struct {
	ID       string    `json:"id" required:"true" title:"Unique task ID"`
	DateTime time.Time `json:"dateTime" required:"true" title:"Date and time" description:"Format examples: 2012-10-01T09:45:00.000+02:00"`
	Schedule bool      `` /* 144-byte string literal not displayed */
}

type TaskAck

type TaskAck struct {
	Task        Task    `json:"task"`
	Context     Context `json:"context"`
	ScheduledIn int64   `json:"scheduledIn"`
	Error       *string `json:"error"`
}