schedule

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 30, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrTaskAdded    = errors.New("task already added")
	ErrTaskNotFound = errors.New("task not found")
)

Functions

This section is empty.

Types

type CronScheduler added in v1.1.0

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

CronScheduler is a scheduler implemented by robfig/cron

func NewCronScheduler added in v1.1.0

func NewCronScheduler() *CronScheduler

func (*CronScheduler) Name added in v1.1.0

func (s *CronScheduler) Name() string

func (*CronScheduler) RunNow added in v1.1.0

func (s *CronScheduler) RunNow(name string)

func (*CronScheduler) Schedule added in v1.1.0

func (s *CronScheduler) Schedule(task Task)

func (*CronScheduler) Start added in v1.1.0

func (s *CronScheduler) Start() error

Start starts the cron scheduler.

func (*CronScheduler) Stop added in v1.1.0

func (s *CronScheduler) Stop(ctx context.Context) error

Stop stops the cron scheduler and waits for running tasks to complete.

type IntervalSchedule added in v1.1.0

type IntervalSchedule struct {
	InitialDelay time.Duration
	Interval     time.Duration
	// contains filtered or unexported fields
}

func NewIntervalSchedule added in v1.1.0

func NewIntervalSchedule(initialDelay time.Duration, interval time.Duration) *IntervalSchedule

func (*IntervalSchedule) Next added in v1.1.0

func (m *IntervalSchedule) Next(t time.Time) time.Time

type Schedule added in v1.1.0

type Schedule interface {
	Next(time.Time) time.Time
}

type Scheduler

type Scheduler interface {
	Schedule(Task)
	RunNow(name string)
	Start() error
	Stop(context.Context) error
}

Scheduler manages scheduled tasks

type Task

type Task struct {
	Name      string
	Scheduled Schedule
	Run       func(ctx context.Context) error
}

Jump to

Keyboard shortcuts

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