Documentation
¶
Overview ¶
gcron 包实现了cron模式解析器和任务运行器。 md5:56d461ee2c75e1f7
Index ¶
- Constants
- func DelayAdd(ctx context.Context, delay time.Duration, pattern string, job JobFunc, ...)
- func DelayAddOnce(ctx context.Context, delay time.Duration, pattern string, job JobFunc, ...)
- func DelayAddSingleton(ctx context.Context, delay time.Duration, pattern string, job JobFunc, ...)
- func DelayAddTimes(ctx context.Context, delay time.Duration, pattern string, times int, ...)
- func GetLogger() glog.ILogger
- func Remove(name string)
- func SetLogger(logger glog.ILogger)
- func Size() int
- func Start(name ...string)
- func Stop(name ...string)
- type Cron
- func (c *Cron) Add(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
- func (c *Cron) AddEntry(ctx context.Context, pattern string, job JobFunc, times int, isSingleton bool, ...) (*Entry, error)
- func (c *Cron) AddOnce(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
- func (c *Cron) AddSingleton(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
- func (c *Cron) AddTimes(ctx context.Context, pattern string, times int, job JobFunc, name ...string) (*Entry, error)
- func (c *Cron) Close()
- func (c *Cron) DelayAdd(ctx context.Context, delay time.Duration, pattern string, job JobFunc, ...)
- func (c *Cron) DelayAddEntry(ctx context.Context, delay time.Duration, pattern string, job JobFunc, ...)
- func (c *Cron) DelayAddOnce(ctx context.Context, delay time.Duration, pattern string, job JobFunc, ...)
- func (c *Cron) DelayAddSingleton(ctx context.Context, delay time.Duration, pattern string, job JobFunc, ...)
- func (c *Cron) DelayAddTimes(ctx context.Context, delay time.Duration, pattern string, times int, ...)
- func (c *Cron) Entries() []*Entry
- func (c *Cron) GetLogger() glog.ILogger
- func (c *Cron) Remove(name string)
- func (c *Cron) Search(name string) *Entry
- func (c *Cron) SetLogger(logger glog.ILogger)
- func (c *Cron) Size() int
- func (c *Cron) Start(name ...string)
- func (c *Cron) Stop(name ...string)
- type Entry
- func Add(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
- func AddOnce(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
- func AddSingleton(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
- func AddTimes(ctx context.Context, pattern string, times int, job JobFunc, name ...string) (*Entry, error)
- func Entries() []*Entry
- func Search(name string) *Entry
- type JobFunc
Constants ¶
const ( StatusReady = gtimer.StatusReady StatusRunning = gtimer.StatusRunning StatusStopped = gtimer.StatusStopped StatusClosed = gtimer.StatusClosed )
Variables ¶
This section is empty.
Functions ¶
func DelayAdd ¶
func DelayAdd(ctx context.Context, delay time.Duration, pattern string, job JobFunc, name ...string)
DelayAdd 在延迟'delay'时间后，向默认的cron对象添加一个定时任务。 md5:7c28aadbf64d1362
func DelayAddOnce ¶
func DelayAddOnce(ctx context.Context, delay time.Duration, pattern string, job JobFunc, name ...string)
DelayAddOnce 在 `delay` 时间后向默认cron对象添加一个定时任务。 这个定时任务只能运行一次。 md5:56e7e748e4d4c63d
func DelayAddSingleton ¶
func DelayAddSingleton(ctx context.Context, delay time.Duration, pattern string, job JobFunc, name ...string)
DelayAddSingleton 在默认的cron对象中延迟`delay`时间后添加一个单例定时任务。 md5:d6c26c1edc16c19a
func DelayAddTimes ¶
func DelayAddTimes(ctx context.Context, delay time.Duration, pattern string, times int, job JobFunc, name ...string)
DelayAddTimes 在`delay`时间后向默认cron对象添加一个定时任务。这个定时任务可以运行指定次数。 md5:b4ecf68ee4e86408
Types ¶
type Cron ¶
type Cron struct {
// contains filtered or unexported fields
}
Cron 存储所有的cron作业项。 md5:3a72b04261d69d0e
func (*Cron) Add ¶
func (c *Cron) Add(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
Add 添加一个定时任务。 一个唯一的`name`可以与定时任务绑定。 如果`name`已经被使用，它将返回一个错误。 md5:850ebd654a2e3695
func (*Cron) AddEntry ¶
func (c *Cron) AddEntry( ctx context.Context, pattern string, job JobFunc, times int, isSingleton bool, name ...string, ) (*Entry, error)
AddEntry 创建并返回一个新的 Entry 对象。 md5:1a7d5709c2867437
func (*Cron) AddOnce ¶
func (c *Cron) AddOnce(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
AddOnce 添加一个定时任务，该任务只能运行一次。 可以为定时任务绑定一个唯一的`name`。 如果`name`已使用，将返回一个错误。 md5:fd5fb4f131e1f937
func (*Cron) AddSingleton ¶
func (c *Cron) AddSingleton(ctx context.Context, pattern string, job JobFunc, name ...string) (*Entry, error)
AddSingleton 添加一个单例定时任务。 单例定时任务是指在同一时间只能运行一个实例的任务。 可以通过一个唯一的`name`与定时任务绑定。 如果`name`已经被使用，它将返回错误。 md5:9e0e86c2aee09877
func (*Cron) AddTimes ¶
func (c *Cron) AddTimes(ctx context.Context, pattern string, times int, job JobFunc, name ...string) (*Entry, error)
AddTimes 添加一个定时任务，可以指定执行次数。 可以为定时任务绑定一个唯一的`name`。 如果`name`已存在，将返回一个错误。 md5:b01e5695f9cc54d5
func (*Cron) DelayAdd ¶
func (c *Cron) DelayAdd(ctx context.Context, delay time.Duration, pattern string, job JobFunc, name ...string)
DelayAdd 在`delay`时间后添加一个定时任务。 md5:027e39a4b8e3b167
func (*Cron) DelayAddEntry ¶
func (c *Cron) DelayAddEntry(ctx context.Context, delay time.Duration, pattern string, job JobFunc, times int, isSingleton bool, name ...string)
DelayAddEntry 在延迟`delay`时间后添加一个定时任务。 md5:a45391b1d2daacd5
func (*Cron) DelayAddOnce ¶
func (c *Cron) DelayAddOnce(ctx context.Context, delay time.Duration, pattern string, job JobFunc, name ...string)
DelayAddOnce 在 `delay` 时间后添加一个定时任务。 这个定时任务只能运行一次。 md5:34aa0df8fb8e5477
func (*Cron) DelayAddSingleton ¶
func (c *Cron) DelayAddSingleton(ctx context.Context, delay time.Duration, pattern string, job JobFunc, name ...string)
DelayAddSingleton 在`delay`时间后添加一个单例计时任务。 md5:c56847cf6733a3e4
func (*Cron) DelayAddTimes ¶
func (c *Cron) DelayAddTimes(ctx context.Context, delay time.Duration, pattern string, times int, job JobFunc, name ...string)
DelayAddTimes 在延迟`delay`时间后添加一个定时任务。 该定时任务可以指定运行次数。 md5:5ed58fb7650ed0bb
type Entry ¶
type Entry struct {
Name string // Entry name.
RegisterTime time.Time // Registered time.
Job JobFunc `json:"-"` // Callback function.
// contains filtered or unexported fields
}
Entry 是定时任务的入口。 md5:ebc0ffec0c819fa5
func Add ¶
Add 向默认的 cron 对象添加一个定时任务。 一个唯一的 `name` 可以与定时任务绑定。 如果 `name` 已经被使用，它将返回一个错误。 md5:0f46b08a5a96144a
func AddOnce ¶
AddOnce 向默认cron对象添加一个仅能运行一次的定时任务。可以为定时任务绑定一个唯一的`name`。 如果`name`已存在，它将返回一个错误。 md5:9701998ce952852d
func AddSingleton ¶
AddSingleton 向默认的 cron 对象添加一个单例定时任务。 单例定时任务是指在同一时间只能运行一个实例的任务。 可以将一个唯一的 `name` 与定时任务绑定。 如果 `name` 已经被使用，它将返回错误。 md5:96268d3e8373359e
func AddTimes ¶
func AddTimes(ctx context.Context, pattern string, times int, job JobFunc, name ...string) (*Entry, error)
AddTimes 将一个定时任务添加到默认cron对象中，该任务可以执行指定次数。可以为定时任务绑定一个唯一的`name`。 如果`name`已经存在，它将返回一个错误。 md5:505a2bbf10529705
func (*Entry) IsSingleton ¶
IsSingleton 判断这个条目是否是定时单例任务。 md5:171967c731b60f88
func (*Entry) SetSingleton ¶
SetSingleton 设置以单例模式运行的条目。 md5:6c81a3a09d0ef0b1
Source Files