scheduler

Documentation

Index

• Variables
• type Job
• type Scheduler
  • func New() *Scheduler
  • func (s *Scheduler) Add(name string, j Job, interval time.Duration) error
  • func (s *Scheduler) AddCron(name string, j Job, expr string) error
  • func (s *Scheduler) Remove(name string) error
  • func (s *Scheduler) Start() error
  • func (s *Scheduler) Stop(ctx context.Context) error

Variables

var (
	ErrInvalidCronExpr = errors.New("invalid cron expression")
	ErrJobAlreadyExist = errors.New("job already exist")
	ErrJobNotFound     = errors.New("job not found")
	ErrAlreadyStarted  = errors.New("already started")
	ErrNotRunning      = errors.New("not running")
)

Errors.

Types

type Job

type Job interface {
	Run()
}

Job is a job representation for the scheduler.

type Scheduler

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

Scheduler schedules jobs to run them at a given interval.

func New

func New() *Scheduler

New returns a scheduler.

func (*Scheduler) Add

func (s *Scheduler) Add(name string, j Job, interval time.Duration) error

Add adds a job in the scheduler. The job runs every interval duration when the scheduler is started or already running.

func (*Scheduler) AddCron

func (s *Scheduler) AddCron(name string, j Job, expr string) error

AddCron adds the job in the scheduler. The job will be run depending on the cron expression when the scheduler is started or already running.

func (*Scheduler) Remove

func (s *Scheduler) Remove(name string) error

Remove removes the job from the scheduler.

func (*Scheduler) Start

func (s *Scheduler) Start() error

Start starts the scheduler.

func (*Scheduler) Stop

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

Stop stops the scheduler.