schedule

package module

v1.0.14 Latest Latest Go to latest Published: Jul 16, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Info struct {
	UpdateTime time.Time
	Key        string
	// contains filtered or unexported fields
}

Info holds metadata for a scheduled cron job.

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

Schedule manages cron jobs with key-based and ID-based lifecycle control.

func NewSchedule(opts ...cron.Option) *Schedule

NewSchedule creates a new Schedule with the given cron options.

func NewScheduleWithSeconds() *Schedule

NewScheduleWithSeconds creates a new Schedule that supports second-level cron granularity.

func (c *Schedule) AddFunc(spec string, cmd func(context2 *core.Context)) (cron.EntryID, error)

AddFunc adds a cron job that runs in the context's goroutine pool.

func (c *Schedule) AddIdOrReplaceKeyFunc(id uint, key string, spec string, cmd func(context2 *core.Context)) (cron.EntryID, bool, error)

AddIdOrReplaceKeyFunc adds or replaces a cron job identified by a numeric ID.

func (c *Schedule) AddKeyFunc(key string, spec string, cmd func(context2 *core.Context)) (cron.EntryID, bool, error)

AddKeyFunc adds a cron job if no job with the given key exists.

func (c *Schedule) GetIds() []uint

GetIds returns all registered numeric IDs.

func (c *Schedule) Init(ctx *core.Context) error

func (c *Schedule) ReplaceKeyFunc(key string, spec string, cmd func(context2 *core.Context)) (cron.EntryID, error)

ReplaceKeyFunc replaces a cron job identified by key with a new spec and command.

func (c *Schedule) Run() error

func (c *Schedule) StopIdFunc(id uint)

StopIdFunc stops a cron job identified by its numeric ID.

func (c *Schedule) StopKeyFunc(key string)

StopKeyFunc stops a cron job identified by its key.