scheduler

Documentation

Index

• type Scheduler
  • func NewScheduler(ctx context.Context) *Scheduler
  • func (s *Scheduler) Shutdown() error
  • func (s *Scheduler) StartJobEvery(duration time.Duration, job func() error) string
  • func (s *Scheduler) StopJob(jobID string) error

Types

type Scheduler

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

func NewScheduler

func NewScheduler(ctx context.Context) *Scheduler

func (*Scheduler) Shutdown

func (s *Scheduler) Shutdown() error

Shutdown stops the scheduler and waits for it to stop if it is running; otherwise does nothing.

func (*Scheduler) StartJobEvery

func (s *Scheduler) StartJobEvery(duration time.Duration, job func() error) string

StartJobEvery schedules a new periodic job with a given duration. Returns job id that could be used to stop the given job. When job run returns an error, that job won't be run again.

func (*Scheduler) StopJob

func (s *Scheduler) StopJob(jobID string) error

StopJob stops the job from being run in the future