cron

Documentation

Overview

Package cron

Package cron

Package cron

Package cron 定时任务

Package cron

Package cron

Index

• Constants
• func EveryFmt(t string) string
• func ModuleName() string
• type Cron
  • func New() *Cron
  • func NewWithOption(ops ...cron.Option) *Cron
  • func NewWithRecover() *Cron
  • func (cronJob *Cron) AddFunc(spec string, f func()) (int, error)
  • func (cronJob *Cron) Cancel(id int)
  • func (cronJob *Cron) JobSpec(id int) string
  • func (cronJob *Cron) Jobs() map[int]string
  • func (cronJob *Cron) Start()
  • func (cronJob *Cron) Stop()
• type CronGroup
  • func NewGroup(spec string) *CronGroup
  • func (g *CronGroup) AddFunc(f func()) (int, error)
  • func (g *CronGroup) Cancel(id int)
  • func (g *CronGroup) JobSpec() string
  • func (g *CronGroup) JobsCount() int
  • func (g *CronGroup) Start()
  • func (g *CronGroup) Stop()
• type ScheduleJob
  • func NewSchedule(t time.Time, f func()) *ScheduleJob
  • func (s *ScheduleJob) IsDone() bool
  • func (s *ScheduleJob) IsStart() bool
  • func (s *ScheduleJob) IsStopped() bool
  • func (s *ScheduleJob) ReStart()
  • func (s *ScheduleJob) SetName(name string)
  • func (s *ScheduleJob) Start()
  • func (s *ScheduleJob) Stop()

Constants

const (
	Yearly     = "@yearly"
	Annually   = "@annually"
	Monthly    = "@monthly"
	Daily      = "@daily"
	MidNightly = "@midnight"
	Hourly     = "@hourly"
	Weekly     = "@weekly"
	Every      = "@every" // 后面使用秒s 分m 时h
)

Functions

func EveryFmt

func EveryFmt(t string) string

EveryFmt 每分或每秒 例如1s 例如5m 例如 1h1m

func ModuleName

func ModuleName() string

ModuleName 模块名称

Types

type Cron

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

func New

func New() *Cron

New 创建支持秒级的定时器

func NewWithOption

func NewWithOption(ops ...cron.Option) *Cron

NewWithOption 附加原生cron v3配置

func NewWithRecover

func NewWithRecover() *Cron

NewWithRecover 创建带recover的支持秒级的定时器

func (*Cron) AddFunc

func (cronJob *Cron) AddFunc(spec string, f func()) (int, error)

AddFunc 添加规则 spec 为标准的cronjob表达式 返回为唯一的定时id和错误

func (*Cron) Cancel

func (cronJob *Cron) Cancel(id int)

Cancel 取消指定的任务

func (*Cron) JobSpec

func (cronJob *Cron) JobSpec(id int) string

JobSpec 返回指定任务的规则

func (*Cron) Jobs

func (cronJob *Cron) Jobs() map[int]string

Jobs 展示当前加入的任务

func (*Cron) Start

func (cronJob *Cron) Start()

Start 启动cronJob

func (*Cron) Stop

func (cronJob *Cron) Stop()

Stop 停止cronJob

type CronGroup

type CronGroup struct {
	Spec string // cronjob规则
	// contains filtered or unexported fields
}

CronGroup 相同定时的任务组

func NewGroup

func NewGroup(spec string) *CronGroup

NewGroup 新建一个规则分组

func (*CronGroup) AddFunc

func (g *CronGroup) AddFunc(f func()) (int, error)

AddFunc 添加一个定时任务

func (*CronGroup) Cancel

func (g *CronGroup) Cancel(id int)

func (*CronGroup) JobSpec

func (g *CronGroup) JobSpec() string

func (*CronGroup) JobsCount

func (g *CronGroup) JobsCount() int

func (*CronGroup) Start

func (g *CronGroup) Start()

func (*CronGroup) Stop

func (g *CronGroup) Stop()

type ScheduleJob

type ScheduleJob struct {
	ExecTime time.Time // 执行时间
	Name     string    // 可选 任务名称
	// contains filtered or unexported fields
}

func NewSchedule

func NewSchedule(t time.Time, f func()) *ScheduleJob

NewSchedule 创建一个计划任务 给定的时间如果在过去或等于现在的时间 不做任何事情

func (*ScheduleJob) IsDone

func (s *ScheduleJob) IsDone() bool

IsDone 是否执行完毕

func (*ScheduleJob) IsStart

func (s *ScheduleJob) IsStart() bool

IsStart 任务是否启动

func (*ScheduleJob) IsStopped

func (s *ScheduleJob) IsStopped() bool

IsStopped 是否停止

func (*ScheduleJob) ReStart

func (s *ScheduleJob) ReStart()

ReStart 从停止状态下重新启动

func (*ScheduleJob) SetName

func (s *ScheduleJob) SetName(name string)

func (*ScheduleJob) Start

func (s *ScheduleJob) Start()

func (*ScheduleJob) Stop

func (s *ScheduleJob) Stop()