gcron

Documentation

Overview

Package gcron implements a cron pattern parser and job runner.

定时任务.

Index

• Constants
• func DelayAdd(delay time.Duration, pattern string, job func(), name ...string)
• func DelayAddOnce(delay time.Duration, pattern string, job func(), name ...string)
• func DelayAddSingleton(delay time.Duration, pattern string, job func(), name ...string)
• func DelayAddTimes(delay time.Duration, pattern string, times int, job func(), name ...string)
• func GetLogLevel() int
• func GetLogPath() string
• func Remove(name string)
• func SetLogLevel(level int)
• func SetLogPath(path string)
• func Size() int
• func Start(name string)
• func Stop(name string)
• type Cron
  • func New() *Cron
  • func (c *Cron) Add(pattern string, job func(), name ...string) (*Entry, error)
  • func (c *Cron) AddOnce(pattern string, job func(), name ...string) (*Entry, error)
  • func (c *Cron) AddSingleton(pattern string, job func(), name ...string) (*Entry, error)
  • func (c *Cron) AddTimes(pattern string, times int, job func(), name ...string) (*Entry, error)
  • func (c *Cron) Close()
  • func (c *Cron) DelayAdd(delay time.Duration, pattern string, job func(), name ...string)
  • func (c *Cron) DelayAddOnce(delay time.Duration, pattern string, job func(), name ...string)
  • func (c *Cron) DelayAddSingleton(delay time.Duration, pattern string, job func(), name ...string)
  • func (c *Cron) DelayAddTimes(delay time.Duration, pattern string, times int, job func(), name ...string)
  • func (c *Cron) Entries() []*Entry
  • func (c *Cron) GetLogLevel() int
  • func (c *Cron) GetLogPath() string
  • func (c *Cron) Remove(name string)
  • func (c *Cron) Search(name string) *Entry
  • func (c *Cron) SetLogLevel(level int)
  • func (c *Cron) SetLogPath(path string)
  • func (c *Cron) Size() int
  • func (c *Cron) Start(name ...string)
  • func (c *Cron) Stop(name ...string)
• type Entry
  • func Add(pattern string, job func(), name ...string) (*Entry, error)
  • func AddOnce(pattern string, job func(), name ...string) (*Entry, error)
  • func AddSingleton(pattern string, job func(), name ...string) (*Entry, error)
  • func AddTimes(pattern string, times int, job func(), name ...string) (*Entry, error)
  • func Entries() []*Entry
  • func Search(name string) *Entry
  • func (entry *Entry) Close()
  • func (entry *Entry) IsSingleton() bool
  • func (entry *Entry) SetSingleton(enabled bool)
  • func (entry *Entry) SetStatus(status int) int
  • func (entry *Entry) SetTimes(times int)
  • func (entry *Entry) Start()
  • func (entry *Entry) Status() int
  • func (entry *Entry) Stop()

Examples

• Cron.AddSingleton

Constants

const (
	STATUS_READY   = gtimer.STATUS_READY
	STATUS_RUNNING = gtimer.STATUS_RUNNING
	STATUS_STOPPED = gtimer.STATUS_STOPPED
	STATUS_CLOSED  = gtimer.STATUS_CLOSED
)

Functions

func DelayAdd

func DelayAdd(delay time.Duration, pattern string, job func(), name ...string)

延迟添加定时任务

func DelayAddOnce

func DelayAddOnce(delay time.Duration, pattern string, job func(), name ...string)

延迟添加只运行一次的定时任务，delay参数单位为秒

func DelayAddSingleton

func DelayAddSingleton(delay time.Duration, pattern string, job func(), name ...string)

延迟添加单例定时任务，delay参数单位为秒

func DelayAddTimes

func DelayAddTimes(delay time.Duration, pattern string, times int, job func(), name ...string)

延迟添加运行指定次数的定时任务，delay参数单位为秒

func GetLogLevel

func GetLogLevel() int

获取日志输出等级。

func GetLogPath

func GetLogPath() string

获取设置的日志输出路径

func Remove

func Remove(name string)

根据指定名称删除定时任务

func SetLogLevel

func SetLogLevel(level int)

设置日志输出等级。

func SetLogPath

func SetLogPath(path string)

设置日志输出路径

func Size

func Size() int

获取所有已注册的定时任务数量

func Start

func Start(name string)

启动指定的定时任务

func Stop

func Stop(name string)

停止指定的定时任务

Types

type Cron

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

定时任务管理对象

func New

func New() *Cron

创建自定义的定时任务管理对象

func (*Cron) Add

func (c *Cron) Add(pattern string, job func(), name ...string) (*Entry, error)

添加定时任务

func (*Cron) AddOnce

func (c *Cron) AddOnce(pattern string, job func(), name ...string) (*Entry, error)

添加只运行一次的定时任务

func (*Cron) AddSingleton

func (c *Cron) AddSingleton(pattern string, job func(), name ...string) (*Entry, error)

添加单例运行定时任务

Example

package main

import (
	"github.com/gogf/gf/g/os/gcron"
	"github.com/gogf/gf/g/os/glog"
	"time"
)

func main() {
	gcron.AddSingleton("* * * * * *", func() {
		glog.Println("doing")
		time.Sleep(2 * time.Second)
	})
	select {}
}

func (*Cron) AddTimes

func (c *Cron) AddTimes(pattern string, times int, job func(), name ...string) (*Entry, error)

添加运行指定次数的定时任务

func (*Cron) Close

func (c *Cron) Close()

关闭定时任务

func (*Cron) DelayAdd

func (c *Cron) DelayAdd(delay time.Duration, pattern string, job func(), name ...string)

延迟添加定时任务

func (*Cron) DelayAddOnce

func (c *Cron) DelayAddOnce(delay time.Duration, pattern string, job func(), name ...string)

延迟添加运行指定次数的定时任务

func (*Cron) DelayAddSingleton

func (c *Cron) DelayAddSingleton(delay time.Duration, pattern string, job func(), name ...string)

延迟添加单例定时任务

func (*Cron) DelayAddTimes

func (c *Cron) DelayAddTimes(delay time.Duration, pattern string, times int, job func(), name ...string)

延迟添加只运行一次的定时任务

func (*Cron) Entries

func (c *Cron) Entries() []*Entry

获取所有已注册的定时任务项(按照注册时间从小到大进行排序)

func (*Cron) GetLogLevel

func (c *Cron) GetLogLevel() int

获取日志输出等级。

func (*Cron) GetLogPath

func (c *Cron) GetLogPath() string

获取设置的日志输出路径

func (*Cron) Remove

func (c *Cron) Remove(name string)

根据指定名称删除定时任务。

func (*Cron) Search

func (c *Cron) Search(name string) *Entry

检索指定名称的定时任务

func (*Cron) SetLogLevel

func (c *Cron) SetLogLevel(level int)

设置日志输出等级。

func (*Cron) SetLogPath

func (c *Cron) SetLogPath(path string)

设置日志输出路径

func (*Cron) Size

func (c *Cron) Size() int

获取所有已注册的定时任务数量

func (*Cron) Start

func (c *Cron) Start(name ...string)

开启定时任务执行(可以指定特定名称的一个或若干个定时任务)

func (*Cron) Stop

func (c *Cron) Stop(name ...string)

停止定时任务执行(可以指定特定名称的一个或若干个定时任务)

type Entry

type Entry struct {
	Name string    // Entry name.
	Job  func()    `json:"-"` // Callback function.
	Time time.Time // Registered time.
	// contains filtered or unexported fields
}

Timed task entry.

func Add

func Add(pattern string, job func(), name ...string) (*Entry, error)

添加定时任务，可以给定名字，以便于后续执行删除

func AddOnce

func AddOnce(pattern string, job func(), name ...string) (*Entry, error)

添加只运行一次的定时任务

func AddSingleton

func AddSingleton(pattern string, job func(), name ...string) (*Entry, error)

添加单例运行定时任务

func AddTimes

func AddTimes(pattern string, times int, job func(), name ...string) (*Entry, error)

添加运行指定次数的定时任务

func Entries

func Entries() []*Entry

获取所有已注册的定时任务项

func Search

func Search(name string) *Entry

检索指定名称的定时任务

func (*Entry) Close

func (entry *Entry) Close()

关闭定时任务

func (*Entry) IsSingleton

func (entry *Entry) IsSingleton() bool

是否单例运行

func (*Entry) SetSingleton

func (entry *Entry) SetSingleton(enabled bool)

设置单例运行

func (*Entry) SetStatus

func (entry *Entry) SetStatus(status int) int

设置定时任务状态, 返回设置之前的状态

func (*Entry) SetTimes

func (entry *Entry) SetTimes(times int)

设置任务的运行次数

func (*Entry) Start

func (entry *Entry) Start()

启动定时任务

func (*Entry) Status

func (entry *Entry) Status() int

定时任务状态

func (*Entry) Stop

func (entry *Entry) Stop()

停止定时任务