scheduler

Documentation

Index

• Constants
• type Config
• type CronRouter
• type JobFunc
• type JobSetting
• type Scheduler
  • func New(m lifecycle.Lifecycle, log log.Logger, opts []*Config, routers []CronRouter, ...) *Scheduler
  • func (s *Scheduler) Cron(name, expr string, fn JobFunc)
  • func (s *Scheduler) Every(name string, dur time.Duration, fn JobFunc)
  • func (s *Scheduler) Once(name string, delay time.Duration, fn JobFunc)

Constants

const Name = "scheduler"

Types

type Config

type Config struct {
	Timeout     string       `yaml:"timeout"`
	JobSettings []JobSetting `yaml:"jobs"`
}

type CronRouter

type CronRouter interface {
	Crontab(s *Scheduler)
}

type JobFunc

type JobFunc func(ctx context.Context, name string) error

type JobSetting

type JobSetting struct {
	Disabled bool   `yaml:"disabled"`
	Schedule string `yaml:"schedule"`
	Name     string `yaml:"name"`
	Timeout  string `yaml:"timeout"`
}

type Scheduler

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

func New

func New(m lifecycle.Lifecycle, log log.Logger, opts []*Config, routers []CronRouter, metric metrics.Metric) *Scheduler

func (*Scheduler) Cron

func (s *Scheduler) Cron(name, expr string, fn JobFunc)

func (*Scheduler) Every

func (s *Scheduler) Every(name string, dur time.Duration, fn JobFunc)

func (*Scheduler) Once

func (s *Scheduler) Once(name string, delay time.Duration, fn JobFunc)