scheduler

Documentation

Index

• Constants
• Variables
• func MachineCollection(tree *hsm.Node) hsm.Collection[Scheduler]
• func RegisterExecutor(registry *hsm.Registry, executorOptions TaskExecutorOptions, config *Config) error
• func RegisterStateMachine(r *hsm.Registry) error
• func RegisterTaskSerializers(reg *hsm.Registry) error
• type Config
  • func ConfigProvider(dc *dynamicconfig.Collection) *Config
• type EventSchedulerActivate
• type ScheduleTask
  • func (ScheduleTask) Concurrent() bool
  • func (t ScheduleTask) Kind() hsm.TaskKind
  • func (ScheduleTask) Type() string
• type ScheduleTaskSerializer
  • func (ScheduleTaskSerializer) Deserialize(data []byte, kind hsm.TaskKind) (hsm.Task, error)
  • func (ScheduleTaskSerializer) Serialize(hsm.Task) ([]byte, error)
• type Scheduler
  • func NewScheduler(args *schedspb.StartScheduleArgs) Scheduler
  • func (s Scheduler) RegenerateTasks(*hsm.Node) ([]hsm.Task, error)
  • func (s Scheduler) SetState(state enumsspb.SchedulerState)
  • func (s Scheduler) State() enumsspb.SchedulerState
• type TaskExecutorOptions
  • func TaskExecutorOptionsProvider() TaskExecutorOptions

Constants

const StateMachineType = "scheduler.Scheduler"

Unique type identifier for this state machine.

const (
	TaskTypeSchedule = "scheduler.Schedule"
)

Variables

var Module = fx.Module(
	"component.scheduler",
	fx.Provide(ConfigProvider),
	fx.Provide(TaskExecutorOptionsProvider),
	fx.Invoke(RegisterTaskSerializers),
	fx.Invoke(RegisterStateMachine),
	fx.Invoke(RegisterExecutor),
)

var TransitionSchedulerActivate = hsm.NewTransition(
	[]enumsspb.SchedulerState{enumsspb.SCHEDULER_STATE_WAITING},
	enumsspb.SCHEDULER_STATE_WAITING,
	func(scheduler Scheduler, event EventSchedulerActivate) (hsm.TransitionOutput, error) {
		tasks, err := scheduler.RegenerateTasks(nil)
		return hsm.TransitionOutput{Tasks: tasks}, err
	})

var UseExperimentalHsmScheduler = dynamicconfig.NewNamespaceBoolSetting(
	"scheduler.use-experimental-hsm-scheduler",
	false,
	"When true, use the experimental scheduler implemented using the HSM framework instead of workflows")

Functions

func MachineCollection

func MachineCollection(tree *hsm.Node) hsm.Collection[Scheduler]

MachineCollection creates a new typed [statemachines.Collection] for callbacks.

func RegisterExecutor

func RegisterExecutor(
	registry *hsm.Registry,
	executorOptions TaskExecutorOptions,
	config *Config,
) error

func RegisterStateMachine

func RegisterStateMachine(r *hsm.Registry) error

func RegisterTaskSerializers

func RegisterTaskSerializers(reg *hsm.Registry) error

Types

type Config

type Config struct {
}

func ConfigProvider

func ConfigProvider(dc *dynamicconfig.Collection) *Config

type EventSchedulerActivate

type EventSchedulerActivate struct{}

EventSchedulerActivate is triggered when the scheduler state machine should wake up and perform work.

type ScheduleTask

type ScheduleTask struct {
	Deadline time.Time
}

func (ScheduleTask) Concurrent

func (ScheduleTask) Concurrent() bool

func (ScheduleTask) Kind

func (t ScheduleTask) Kind() hsm.TaskKind

func (ScheduleTask) Type

func (ScheduleTask) Type() string

type ScheduleTaskSerializer

type ScheduleTaskSerializer struct{}

func (ScheduleTaskSerializer) Deserialize

func (ScheduleTaskSerializer) Deserialize(data []byte, kind hsm.TaskKind) (hsm.Task, error)

func (ScheduleTaskSerializer) Serialize

func (ScheduleTaskSerializer) Serialize(hsm.Task) ([]byte, error)

type Scheduler

type Scheduler struct {
	*schedspb.HsmSchedulerState
}

Callback state machine.

func NewScheduler

func NewScheduler(args *schedspb.StartScheduleArgs) Scheduler

NewCallback creates a new callback in the STANDBY state from given params.

func (Scheduler) RegenerateTasks

func (s Scheduler) RegenerateTasks(*hsm.Node) ([]hsm.Task, error)

func (Scheduler) SetState

func (s Scheduler) SetState(state enumsspb.SchedulerState)

func (Scheduler) State

func (s Scheduler) State() enumsspb.SchedulerState

type TaskExecutorOptions

type TaskExecutorOptions struct {
}

func TaskExecutorOptionsProvider

func TaskExecutorOptionsProvider() TaskExecutorOptions