jobs

Documentation

Overview

A job runner for executing scheduled or ad-hoc tasks asynchronously from HTTP requests.

It adds a couple of features on top of the cron package to make it play nicely with Revel:

1. Protection against job panics. (They print to ERROR instead of take down the process)
2. (Optional) Limit on the number of jobs that may run simulatenously, to limit resource consumption.
3. (Optional) Protection against multiple instances of a single job running concurrently. If one execution runs into the next, the next will be queued.
4. Cron expressions may be defined in app.conf and are reusable across jobs.
5. Job status reporting.

Index

• Constants
• Variables
• func Every(duration time.Duration, job cron.Job)
• func In(duration time.Duration, job cron.Job)
• func Now(job cron.Job)
• func Schedule(spec string, job cron.Job)
• type Func
  • func (r Func) Run()
• type Job
  • func New(job cron.Job) *Job
  • func (j *Job) Run()
  • func (j *Job) Status() string

Constants

const DEFAULT_JOB_POOL_SIZE = 10

const UNNAMED = "(unnamed)"

Variables

var (
	// Singleton instance of the underlying job scheduler.
	MainCron *cron.Cron
)

Functions

func Every

func Every(duration time.Duration, job cron.Job)

Run the given job at a fixed interval. The interval provided is the time between the job ending and the job being run again. The time that the job takes to run is not included in the interval.

func In

func In(duration time.Duration, job cron.Job)

Run the given job once, after the given delay.

func Now

func Now(job cron.Job)

Run the given job right now.

func Schedule

func Schedule(spec string, job cron.Job)

Types

type Func

type Func func()

Callers can use jobs.Func to wrap a raw func. (Copying the type to this package makes it more visible)

For example:

jobs.Schedule("cron.frequent", jobs.Func(myFunc))

func (Func) Run

func (r Func) Run()

type Job

type Job struct {
	Name string
	// contains filtered or unexported fields
}

func New

func New(job cron.Job) *Job

func (*Job) Run

func (j *Job) Run()

func (*Job) Status

func (j *Job) Status() string