cronjobs

package

v1.42.0 Latest Latest Go to latest Published: Aug 16, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Connorig/go-blackbox

Links

Open Source Insights

Documentation ¶

Index ¶

func CronInstance() *cron.Cron
func DoOnce(job cron.Job, t ...time.Duration) error
func GetCron() *cron.Cron
func Register(name, spec string, function TaskFunc) (cron.EntryID, error)
func RegisterSingleton(name, spec string, function TaskFunc) (cron.EntryID, error)
func Remove(name string) error
func SetCron(instance *cron.Cron)
type Task
- func List() []Task
type TaskFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CronInstance ¶

func CronInstance() *cron.Cron

CronInstance cron single instance

func DoOnce ¶

func DoOnce(job cron.Job, t ...time.Duration) error

DoOnce run job once time,this job will run after 2 second

func GetCron ¶ added in v1.36.0

func GetCron() *cron.Cron

GetCron 获取全局调度器;未启用定时任务时返回 nil。

func Register ¶

func Register(name, spec string, function TaskFunc) (cron.EntryID, error)

Register 注册具名定时任务。相同名称重复注册返回错误；任务执行时自动附带 panic 恢复与结构化日志。任务需要由 CronInstance().Start() 启动调度后才会执行。

func RegisterSingleton ¶

func RegisterSingleton(name, spec string, function TaskFunc) (cron.EntryID, error)

RegisterSingleton 注册具名单例任务：同一任务在执行期间不允许再次触发。适用场景：定时任务执行时间可能超过调度间隔的任务（如批量同步）。

func Remove ¶

func Remove(name string) error

Remove 移除已注册任务并停止其调度。任务不存在时返回错误。

func SetCron ¶ added in v1.36.0

func SetCron(instance *cron.Cron)

SetCron 设置全局调度器(InitCronJob 时自动调用)。

Types ¶

type Task ¶

type Task struct {
	Name    string       // 任务名称，注册后不可重复
	Spec    string       // Cron 表达式
	EntryID cron.EntryID // 调度器条目 ID
	AddedAt time.Time    // 注册时间
}

Task 描述一个已注册的具名定时任务。

func List ¶

func List() []Task

List 返回全部已注册任务（按注册顺序）。

type TaskFunc ¶

type TaskFunc func(ctx context.Context) error

TaskFunc 定义定时任务执行函数，任务应响应 ctx 取消。

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL