scheduler

Documentation

Index

• type Scheduler
  • func (sch *Scheduler) AddOnce(id string, start time.Time, fn func(context.Context, time.Time)) bool
  • func (sch *Scheduler) AddRecurring(id string, start time.Time, freq time.Duration, ...) bool
  • func (sch *Scheduler) Cancel(id string) bool
  • func (sch *Scheduler) Start() bool
  • func (sch *Scheduler) Stop() bool

Types

type Scheduler

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

Scheduler wraps an underlying scheduler to provide task tracking by unique string identifiers, so jobs may be cancelled with only an identifier.

func (*Scheduler) AddOnce

func (sch *Scheduler) AddOnce(id string, start time.Time, fn func(context.Context, time.Time)) bool

AddOnce schedules the given task to run at time, registered under the given ID. Returns false if task already exists for id.

func (*Scheduler) AddRecurring

func (sch *Scheduler) AddRecurring(id string, start time.Time, freq time.Duration, fn func(context.Context, time.Time)) bool

AddRecurring schedules the given task to return at given period, starting at given time, registered under given id. Returns false if task already exists for id.

func (*Scheduler) Cancel

func (sch *Scheduler) Cancel(id string) bool

Cancel attempts to cancel a scheduled task with id, returns false if no task found.

func (*Scheduler) Start

func (sch *Scheduler) Start() bool

Start attempts to start the scheduler. Returns false if already running.

func (*Scheduler) Stop

func (sch *Scheduler) Stop() bool

Stop attempts to stop scheduler, cancelling all running tasks. Returns false if not running.