crontab

Documentation

Index

• Variables
• type Config
• type Job
• type JobConfig
• type Scheduler
  • func (s Scheduler) Run(_ context.Context) error
  • func (obj Scheduler) Validate() error
  • func (s Scheduler) WaitForShutdown(ctx context.Context) error
• type SchedulerOption
  • func WithGocronOptions(opts ...gocron.SchedulerOption) SchedulerOption
  • func WithJob(jobName string, cfg JobConfig) SchedulerOption
  • func WithJobRegistry(jobs map[string]Job) SchedulerOption
  • func WithLogger(logger *zap.Logger) SchedulerOption
  • func WithShutdownTimeout(t time.Duration) SchedulerOption

Variables

var New = c.NewWithContextValidate[Scheduler, SchedulerOption]

Types

type Config

type Config struct {
	Jobs map[string]JobConfig `validate:"gt=0,dive,keys,required,endkeys,required"`
}

type Job

type Job func(context.Context) error

type JobConfig

type JobConfig struct {
	Schedule string        `validate:"cron"`
	Timeout  time.Duration `validate:"min=200ms"`
	Enabled  bool
}

type Scheduler

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

func (Scheduler) Run

func (s Scheduler) Run(_ context.Context) error

func (Scheduler) Validate

func (obj Scheduler) Validate() error

func (Scheduler) WaitForShutdown

func (s Scheduler) WaitForShutdown(ctx context.Context) error

type SchedulerOption

type SchedulerOption c.OptionWithContext[Scheduler]

func WithGocronOptions

func WithGocronOptions(opts ...gocron.SchedulerOption) SchedulerOption

func WithJob

func WithJob(jobName string, cfg JobConfig) SchedulerOption

func WithJobRegistry

func WithJobRegistry(jobs map[string]Job) SchedulerOption

func WithLogger

func WithLogger(logger *zap.Logger) SchedulerOption

func WithShutdownTimeout

func WithShutdownTimeout(t time.Duration) SchedulerOption