Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

scheduler

package module

Go to main page

Versions in this module

v0

v0.0.3

Dec 9, 2025

v0.0.2

Mar 25, 2025

Changes in this version

+ const Cancel

+ const Idle

+ const MaxDelay

+ const OpAdd

+ const OpCancel

+ const OpExecute

+ const OpIgnore

+ const OpPause

+ const OpResume

+ const OpStart

+ const OpStop

+ const OpUpdate

+ const Pause

+ const PlanManual

+ const PlanNotFound

+ const PlanStop

+ const Running

+ const Stopped

+ const TaskIsBusy

+ const TaskNotFound

+ const TooManyJob

+ const Waiting

+ var ExecuteParamConflictErr = errors.New("can not specify both cron and interval")

+ var ExecuteParamNotFoundErr = errors.New("job execute parameter cron or interval is not specified")

+ var PlanConfigNotFoundErr = errors.New("plan config not found")

+ var PlanExistErr = errors.New("plan already exist")

+ var PlanNotFoundErr = errors.New("plan not found")

+ var StoppedErr = errors.New("scheduler already stopped")

+ var TaskCodeNotFoundErr = errors.New("task for specified name not found")

+ var TaskExistErr = errors.New("task already exist")

+ var TaskNotFoundErr = errors.New("task not found")

+ func AddPlan(code string, cfg *PlanConfig) error

+ func CancelJob(code, plan string, jobIds ...string) error

+ func CancelPlan(code, plan string) error

+ func CancelTask(code string) context.Context

+ func ExecuteTask(code string, base *types.Time, maxDelay *types.Duration) (string, error)

+ func ExistPlan(code, plan string) bool

+ func ExistTask(code string) bool

+ func JobStatus(code ...string) map[string]map[string]map[string]int32

+ func NewTaskWrapper(task Task, maxDelay *types.Duration, maxWaitingJob int32, ...) *taskWrapper

+ func PausePlan(code, plan string) error

+ func PauseTask(code string)

+ func PlanStatus(code ...string) map[string]map[string]int32

+ func ResumePlan(code, plan string) error

+ func ResumeTask(code string)

+ func TaskJobStatus(code string, plans ...string) map[string]map[string]int32

+ func TaskPlanJobStatus(code, plan string, jobIds ...string) map[string]int32

+ func TaskPlanStatus(code string, plan ...string) map[string]int32

+ func UpdateTask(task Task, params map[string]any) error

+ func WithOpLogger(l OpLogger)

+ type OpLogger func(op *Operate)

+ type Operate struct

+ Code byte

+ EndTime *types.Time

+ Job string

+ Op string

+ Plan string

+ PlanTime *types.Time

+ StartTime *types.Time

+ Task string

+ func (op *Operate) String() string

+ type Option func(op *Operate)

+ type PlanConfig struct

+ Cron string

+ Interval *types.Duration

+ StopAt *types.Time

+ func (cfg *PlanConfig) Check() (err error)

+ func (cfg *PlanConfig) Key() string

type Scheduler

+ func (s *Scheduler) AddPlan(code string, cfg *PlanConfig) (err error)

+ func (s *Scheduler) CancelJob(code, key string, jobIds ...string) (err error)

+ func (s *Scheduler) CancelPlan(code, key string) (err error)

+ func (s *Scheduler) CancelTask(code string) context.Context

+ func (s *Scheduler) ExecuteTask(code string, baseTime *types.Time, maxDelay *types.Duration) (jobId string, err error)

+ func (s *Scheduler) ExistPlan(code, key string) bool

+ func (s *Scheduler) ExistTask(code string) (ok bool)

+ func (s *Scheduler) JobStatus(codes ...string) map[string]map[string]map[string]int32

+ func (s *Scheduler) PausePlan(code, key string) (err error)

+ func (s *Scheduler) PauseTask(code string)

+ func (s *Scheduler) PlanStatus(codes ...string) map[string]map[string]int32

+ func (s *Scheduler) ResumePlan(code, key string) (err error)

+ func (s *Scheduler) ResumeTask(code string)

+ func (s *Scheduler) Start()

+ func (s *Scheduler) Stop() context.Context

+ func (s *Scheduler) TaskJobStatus(code string, plans ...string) map[string]map[string]int32

+ func (s *Scheduler) TaskPlanJobStatus(code, plan string, jobIds ...string) map[string]int32

+ func (s *Scheduler) TaskPlanStatus(code string, plans ...string) map[string]int32

+ func (s *Scheduler) TaskStatus(codes ...string) map[string]int32

+ func (s *Scheduler) UpdateTask(task Task, params map[string]any) (err error)

+ func (s *Scheduler) WithOpLogger(l OpLogger)

type Task

+ Code func() string

type TaskConfig

+ Code string

+ MaxDelay *types.Duration

+ MaxWaitingJob int32

+ Plans []*PlanConfig

+ func (cfg *TaskConfig) SetDefaults(defaults map[string]any)

v0.0.1

Apr 24, 2023

Changes in this version

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

+ 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 struct

+ 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 interface

+ Init func(map[string]interface{}) error

+ Name func() string

+ Run func()

+ func GetTask(name string) Task

+ type TaskConfig struct

+ Cron string

+ Interval int64

+ Name string

+ Params map[string]interface{}

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

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

+ type TaskStatus struct

+ Next time.Time

+ Prev time.Time

+ func GetTaskStatus(name string) *TaskStatus