scheduler

Documentation

Index

• Variables
• func Exist(name string) bool
• func RegisterTask(task Task, cfg *TaskConfig) error
• func RemoveTask(name string)
• func Start()
• func Stop() context.Context
• func TaskList() (tasks []string)
• type Scheduler
  • func (s *Scheduler) Exist(name string) (exist bool)
  • func (s *Scheduler) GetTask(name string) Task
  • func (s *Scheduler) GetTaskStatus(name string) *TaskStatus
  • func (s *Scheduler) RegisterTask(task Task, cfg *TaskConfig) (err error)
  • func (s *Scheduler) RemoveTask(name string)
• type Task
  • func GetTask(name string) Task
• type TaskConfig
  • func (cfg *TaskConfig) AddParam(key string, value interface{})
  • func (cfg *TaskConfig) Check() (err error)
• type TaskStatus
  • func GetTaskStatus(name string) *TaskStatus

Variables

var TaskExistsErr = errors.New("task already exists")

Functions

func Exist

func Exist(name string) bool

func RegisterTask

func RegisterTask(task Task, cfg *TaskConfig) error

func RemoveTask

func RemoveTask(name string)

func Start

func Start()

func Stop

func Stop() context.Context

func TaskList

func TaskList() (tasks []string)

TaskList Snapshot

Types

type Scheduler

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

func (*Scheduler) Exist

func (s *Scheduler) Exist(name string) (exist bool)

func (*Scheduler) GetTask

func (s *Scheduler) GetTask(name string) Task

func (*Scheduler) GetTaskStatus

func (s *Scheduler) GetTaskStatus(name string) *TaskStatus

func (*Scheduler) RegisterTask

func (s *Scheduler) RegisterTask(task Task, cfg *TaskConfig) (err error)

func (*Scheduler) RemoveTask

func (s *Scheduler) RemoveTask(name string)

type Task

type Task interface {
	Name() string
	Run()
	Init(map[string]interface{}) error
}

func GetTask

func GetTask(name string) Task

type TaskConfig

type TaskConfig struct {
	Name     string                 `json:"name,omitempty"`
	Cron     string                 `json:"cron,omitempty"`
	Interval int64                  `json:"interval,omitempty"`
	Params   map[string]interface{} `json:"params,omitempty"`
}

func (*TaskConfig) AddParam

func (cfg *TaskConfig) AddParam(key string, value interface{})

func (*TaskConfig) Check

func (cfg *TaskConfig) Check() (err error)

type TaskStatus

type TaskStatus struct {
	Next time.Time `json:"next"`
	Prev time.Time `json:"prev"`
}

func GetTaskStatus

func GetTaskStatus(name string) *TaskStatus