scheduling

Documentation

Overview

Package scheduling provides tools for scheduling tasks.

Index

• type Scheduler
  • func NewFixedRateScheduler(delay time.Duration, interval time.Duration) Scheduler

Types

type Scheduler

type Scheduler interface {
	// AddTask adds given task to the scheduler.
	AddTask(name string, fn func(ctx context.Context) error)

	// Start starts executing tasks in the background. If the scheduler is already running, this is
	// a noop operation.
	Start()

	// Stop stops executing tasks. If the scheduler is not running, this is a noop operation.
	Stop()
}

Scheduler is an interface for scheduling tasks.

func NewFixedRateScheduler

func NewFixedRateScheduler(delay time.Duration, interval time.Duration) Scheduler

NewFixedRateScheduler creates a new fixed rate scheduler.

The interval must be greater than zero; if not, the scheduler will panic.