cronmodule

Documentation

Index

• func AddSimpleJob(spec string, cmd func()) (cron.EntryID, error)
• func AddSimpleSingletonJob(spec string, cmd func()) (cron.EntryID, error)
• func NewJob(jobName string, spec *string, autoReloadSpec bool, cmd func(), ...) *jobFunc
• func NewJobAndRegister(jobName string, spec *string, autoReloadSpec bool, cmd func(), ...) error
• func RawInstance() *cron.Cron
• func Start()
• type CronModule
  • func (c *CronModule) ModuleConfig() *declaration.ModuleConfig
  • func (c *CronModule) Register() (interface{}, error)
  • func (c *CronModule) Unregister(maxWaitSeconds uint) (bool, error)

Functions

func AddSimpleJob

func AddSimpleJob(spec string, cmd func()) (cron.EntryID, error)

AddSimpleJob 添加简单任务

func AddSimpleSingletonJob

func AddSimpleSingletonJob(spec string, cmd func()) (cron.EntryID, error)

AddSimpleSingletonJob 添加简单单例任务 该任务将忽略正在运行的任务的调度

func NewJob

func NewJob(jobName string, spec *string, autoReloadSpec bool, cmd func(), multiRun ...bool) *jobFunc

NewJob 初始化一个Job配置

func NewJobAndRegister

func NewJobAndRegister(jobName string, spec *string, autoReloadSpec bool, cmd func(), multiRun ...bool) error

NewJobAndRegister 初始化一个Job配置 并注册

func RawInstance

func RawInstance() *cron.Cron

func Start

func Start()

Start 启动已注册任务 如果CronModule.ManualStart = true时一定需要手动开启

Types

type CronModule

type CronModule struct {
	// 启动日志
	EnableLogger bool

	// 手动启动定时任务
	ManualStart bool
}

func (*CronModule) ModuleConfig

func (c *CronModule) ModuleConfig() *declaration.ModuleConfig

func (*CronModule) Register

func (c *CronModule) Register() (interface{}, error)

func (*CronModule) Unregister

func (c *CronModule) Unregister(maxWaitSeconds uint) (bool, error)