crontab

Documentation

Index

• Variables
• func DataStats() *jsongen.Map
• func IsRealBlocked() error
• func IsValidSpec(spec string, parser ...cron.Parser) bool
• func StopJob(name string) bool
• type Job
  • func AddJob(ctx context.Context, name, spec string, runner Runner, ...) (*Job, error)
  • func GetJob(name string) (*Job, bool)
  • func (j *Job) IsRunning() bool
  • func (j *Job) Name() string
  • func (j *Job) Next() time.Time
  • func (j *Job) Prev() time.Time
  • func (j *Job) Stop()
• type M
  • func (m *M) Runtime() error
  • func (m *M) Start() error
  • func (m *M) Stop() error
• type Runner

Variables

var (
	ErrJobBlocked = errors.New("job is blocked")
	BlockedLimit  = 2 * time.Second
)

var DefaultParser = cron.NewParser(
	cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
)

DefaultParser 等于 WithSecondOptional()

Functions

func DataStats

func DataStats() *jsongen.Map

func IsRealBlocked

func IsRealBlocked() error

IsRealBlocked 场景: 任务设置了立即执行, 00:59.999 刚开始执行, 下次执行时间 01:00 跟着就到了, 再次启动了任务, 但没抢到锁, 忽略该次 Blocked

func IsValidSpec

func IsValidSpec(spec string, parser ...cron.Parser) bool

IsValidSpec 检查定时任务标识是否有效

func StopJob

func StopJob(name string) bool

StopJob 通过名称停止任务

Types

type Job

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

func AddJob

func AddJob(ctx context.Context, name, spec string, runner Runner, opts ...cron.EntryOption) (*Job, error)

AddJob 添加任务

func GetJob

func GetJob(name string) (*Job, bool)

GetJob 通过名称获取任务对象

func (*Job) IsRunning

func (j *Job) IsRunning() bool

func (*Job) Name

func (j *Job) Name() string

func (*Job) Next

func (j *Job) Next() time.Time

func (*Job) Prev

func (j *Job) Prev() time.Time

func (*Job) Stop

func (j *Job) Stop()

type M

type M struct{}

func (*M) Runtime

func (m *M) Runtime() error

Runtime 重新加载配置时运行

func (*M) Start

func (m *M) Start() error

Start 程序启动时初始化

func (*M) Stop

func (m *M) Stop() error

Stop 程序退出时运行

type Runner

type Runner interface {
	Run(ctx context.Context) error
}