clockwerk

README

clockwerk

Job Scheduling Library

clockwerk allows you to schedule periodic jobs using a simple, fluent syntax.

Installing

Using clockwerk is easy. First, use go get to install the latest version of the library.

go get -u github.com/onatm/clockwerk@latest

Usage

Include clockwerk in your application:

import "github.com/onatm/clockwerk"

Example

package main

import (
  "fmt"
  "time"
  "github.com/onatm/clockwerk"
)

type DummyJob struct{}

func (d DummyJob) Run() {
  fmt.Println("Every 30 seconds")
}

func main() {
  var job DummyJob
  c := clockwerk.New()
  c.Every(30 * time.Second).Do(job)
  c.Start()
}

Documentation

Overview

Package clockwerk implements an in-process scheduler for periodic jobs.

Usage

Callers may register Jobs to be invoked on a given schedule. Clockwerk will run them in their own goroutines.

type DummyJob struct{}

func (d DummyJob) Run() {
  fmt.Println("Every 30 seconds")
}
...
var job DummyJob
c := clockwerk.New()
c.Every(30 * time.Second).Do(job)
c.Start()
...
// Funcs are invoked in their own goroutine, asynchronously.
...
c.Stop()  // Stop the scheduler (does not stop any jobs already running).

Index

• type Clockwerk
  • func New() *Clockwerk
  • func (c *Clockwerk) Every(period time.Duration) *Entry
  • func (c *Clockwerk) Start()
  • func (c *Clockwerk) Stop()
• type Entry
  • func (e *Entry) Do(job Job)
• type Job

Types

type Clockwerk

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

Clockwerk keeps track of any number of entries, invoking associated Job's Run method as specified by the schedule.

func New

func New() *Clockwerk

New returns a new Clockwerk job runner.

func (*Clockwerk) Every

func (c *Clockwerk) Every(period time.Duration) *Entry

Every schedules a new Entry and returns it.

func (*Clockwerk) Start

func (c *Clockwerk) Start()

Start the Clockwerk in its own go-routine, or no-op if already started.

func (*Clockwerk) Stop

func (c *Clockwerk) Stop()

Stop the Clockwerk if it is running.

type Entry

type Entry struct {
	Period time.Duration
	Next   time.Time
	Job    Job
}

Entry consists of a schedule and the job to execute on that schedule.

func (*Entry) Do

func (e *Entry) Do(job Job)

Do adds a Job to the Entry.

type Job

type Job interface {
	Run()
}

Job is an interface for added jobs.