scheduler

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 16, 2026

Changes in this version

type AdaptiveJob

+ NextSchedule func(current Schedule) (Schedule, error)

+ type NextScheduleFunc func(Schedule) (Schedule, error)

type Option

+ func WithSchedulerHooks(hooks SchedulerHooks) Option

type Scheduler

+ func (s *Scheduler) Pause()

+ func (s *Scheduler) Resume()

+ func (s *Scheduler) Stop(ctx context.Context) error

+ type SchedulerHooks struct

+ OnStart func(context.Context)

+ OnStopped func(context.Context)

+ OnStopping func(context.Context)

+ OnTick func(context.Context, TickEvent)

+ type TickEvent struct

+ At time.Time

+ Dispatched []JobID

+ DueJobs []JobID

v0.1.0

Jul 12, 2026

Changes in this version

+ type AdaptiveJob interface

+ RunAdaptive func(context.Context) (Schedule, error)

+ type AdaptiveJobFunc func(context.Context) (Schedule, error)

+ func (fn AdaptiveJobFunc) Run(ctx context.Context) error

+ func (fn AdaptiveJobFunc) RunAdaptive(ctx context.Context) (Schedule, error)

type Scheduler

+ func (s *Scheduler) AddAdaptiveCronFunc(spec string, fn AdaptiveJobFunc, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddAdaptiveCronJob(spec string, job AdaptiveJob, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddAdaptiveFunc(schedule Schedule, fn AdaptiveJobFunc, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddAdaptiveIntervalFunc(interval time.Duration, fn AdaptiveJobFunc, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddAdaptiveIntervalJob(interval time.Duration, job AdaptiveJob, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) FrozenIDs() []JobID

v0.0.1

Jul 12, 2026

Changes in this version

+ var ErrInvalidInterval = errors.New("interval must be greater than zero")

+ var ErrInvalidSchedule = errors.New("scheduler schedule must return a future time")

+ var ErrNilContext = errors.New("scheduler context must not be nil")

+ var ErrNilJob = errors.New("scheduler job must not be nil")

+ var ErrNilSchedule = errors.New("scheduler schedule must not be nil")

+ var ErrSchedulerRunning = errors.New("scheduler is already running")

+ var ErrUnknownJob = errors.New("scheduler job ID was not found")

+ type BackoffFactory func() backoff.Backoff

+ type Clock interface

+ NewTimer func(time.Duration) Timer

+ Now func() time.Time

+ type Event struct

+ Attempt int

+ Error error

+ JobID JobID

+ RetryDelay time.Duration

+ type Hooks struct

+ OnFailure func(context.Context, Event)

+ OnRetry func(context.Context, Event)

+ OnSkip func(context.Context, Event)

+ OnStart func(context.Context, Event)

+ OnSuccess func(context.Context, Event)

+ type IntervalSchedule struct

+ func NewIntervalSchedule(interval time.Duration) (IntervalSchedule, error)

+ func (s IntervalSchedule) Next(after time.Time) time.Time

+ type Job interface

+ Run func(context.Context) error

+ type JobFunc func(context.Context) error

+ func (fn JobFunc) Run(ctx context.Context) error

+ type JobID string

+ type Option func(*Scheduler)

+ func WithClock(clock Clock) Option

+ type OverlapPolicy uint8

+ const AllowOverlap

+ const SkipOverlap

+ type RegistrationOption func(*registrationOptions)

+ func WithHooks(hooks Hooks) RegistrationOption

+ func WithID(id JobID) RegistrationOption

+ func WithOverlap(policy OverlapPolicy) RegistrationOption

+ func WithRetry(attempts int, factory BackoffFactory) RegistrationOption

+ func WithTimeout(timeout time.Duration) RegistrationOption

+ type Schedule interface

+ Next func(after time.Time) time.Time

+ func NewCronSchedule(expr string) (Schedule, error)

+ type ScheduleFunc func(time.Time) time.Time

+ func (fn ScheduleFunc) Next(after time.Time) time.Time

+ type Scheduler struct

+ func New(options ...Option) *Scheduler

+ func (s *Scheduler) Add(schedule Schedule, job Job, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddCronFunc(spec string, fn JobFunc, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddCronJob(spec string, job Job, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddFunc(schedule Schedule, fn JobFunc, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddIntervalFunc(interval time.Duration, fn JobFunc, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) AddIntervalJob(interval time.Duration, job Job, options ...RegistrationOption) (JobID, error)

+ func (s *Scheduler) Remove(id JobID) error

+ func (s *Scheduler) Run(ctx context.Context) error

+ type Timer interface

+ Chan func() <-chan time.Time

+ Stop func()

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