jobs

README

jobs

Package jobs providers a scheduler for scheduling background jobs.

Documentation

Overview

Package jobs providers a scheduler for background jobs.

Index

• Variables
• func Schedule(fn func(), expr Expression)
• func Start()
• func Stop()
• type Expression
• type Scheduler
  • func NewScheduler() *Scheduler
  • func (s *Scheduler) Schedule(fn func(), expr Expression)
  • func (s *Scheduler) Start()
  • func (s *Scheduler) Stop()

Variables

var (
	// DefaultScheduler represents the default jobs scheduler.
	DefaultScheduler = NewScheduler()
)

Functions

func Schedule

func Schedule(fn func(), expr Expression)

Schedule adds a job to default scheduler. This is short for DefaultScheduler.Schedule.

func Start

func Start()

Start starts the default scheduler. This is short for DefaultScheduler.Start.

func Stop

func Stop()

Stop stops the default scheduler. This is short for DefaultScheduler.Stop.

Types

type Expression

type Expression interface {
	// Next returns the closest activated time from given time.
	Next(time.Time) time.Time
}

Expression represents an expression specifies a duty cycle.

type Scheduler

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

Scheduler represents a scheduler for jobs.

func NewScheduler

func NewScheduler() *Scheduler

NewScheduler returns a new scheduler.

func (*Scheduler) Schedule

func (s *Scheduler) Schedule(fn func(), expr Expression)

Schedule adds a job to the scheduler.

func (*Scheduler) Start

func (s *Scheduler) Start()

Start starts the scheduler for scheduling tasks.

func (*Scheduler) Stop

func (s *Scheduler) Stop()

Stop stops scheduler.