cron

Documentation

Index

• func Start(ctx context.Context, config Config, eventSource schemaeventsource.EventSource, ...) error
• type Config
• type CronEvent
  • func (e CronEvent) Handle(state CronState) (CronState, error)
  • func (e CronEvent) MarshalBinary() ([]byte, error)
  • func (e *CronEvent) UnmarshalBinary(data []byte) error
• type CronState
  • func CronStateFromProto(v *destpb.CronState) (out *CronState, err error)
  • func (v *CronState) Marshal() ([]byte, error)
  • func (x *CronState) ToProto() *destpb.CronState
  • func (v *CronState) Unmarshal(data []byte) error

Functions

func Start

func Start(ctx context.Context, config Config, eventSource schemaeventsource.EventSource, client routing.CallClient, timelineClient *timelineclient.Client) error

Start the cron service. Blocks until the context is cancelled.

Types

type Config

type Config struct {
	Bind                  *url.URL        `help:"Address to bind to." env:"FTL_BIND" default:"http://127.0.0.1:8990"`
	SchemaServiceEndpoint *url.URL        `name:"ftl-endpoint" help:"Schema Service endpoint." env:"FTL_SCHEMA_ENDPOINT" default:"http://127.0.0.1:8897"`
	TimelineEndpoint      *url.URL        `help:"Timeline endpoint." env:"FTL_TIMELINE_ENDPOINT" default:"http://127.0.0.1:8894"`
	Raft                  raft.RaftConfig `embed:"" prefix:"raft-"`
}

type CronEvent

type CronEvent struct {
	// Job that was executed
	JobKey string
	// When the job was executed
	ExecutedAt time.Time
	// Next scheduled execution
	NextExecution time.Time
}

CronEvent represents changes to the cron state

func (CronEvent) Handle

func (e CronEvent) Handle(state CronState) (CronState, error)

Handle applies the event to the view

func (CronEvent) MarshalBinary

func (e CronEvent) MarshalBinary() ([]byte, error)

func (*CronEvent) UnmarshalBinary

func (e *CronEvent) UnmarshalBinary(data []byte) error

type CronState

type CronState struct {
	// Map of job key to last execution time
	LastExecutions map[string]time.Time `protobuf:"1"`
	// Map of job key to next scheduled time
	NextExecutions map[string]time.Time `protobuf:"2"`
}

CronState is the state of scheduled cron jobs

func CronStateFromProto

func CronStateFromProto(v *destpb.CronState) (out *CronState, err error)

func (*CronState) Marshal

func (v *CronState) Marshal() ([]byte, error)

func (*CronState) ToProto

func (x *CronState) ToProto() *destpb.CronState

func (*CronState) Unmarshal

func (v *CronState) Unmarshal(data []byte) error