cron

package

v1.0.0 Latest Latest Go to latest Published: Feb 22, 2019 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ess/cronenberg

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cron provides mechanisms for using the upstream cron package.

Index ¶

func New() cronenberg.Cron
func NewRunner(job *cronenberg.Job, logger cronenberg.Logger) cronenberg.Runner
type Cron
- func (c *Cron) Count() int
- func (c *Cron) Manage(runner cronenberg.Runner) error
type Runner

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New() cronenberg.Cron

New creates a new instance of Cron.

func NewRunner ¶

func NewRunner(job *cronenberg.Job, logger cronenberg.Logger) cronenberg.Runner

NewRunner takes a Job and a Logger, using them to configure the returned Runner.

Types ¶

type Cron ¶

type Cron struct {
	*cron.Cron
}

Cron is an object that uses the upstream cron package to manage a collection of Runners.

func (*Cron) Count ¶

func (c *Cron) Count() int

Count is the number of Runners scheduled in the Cron at any given time.

func (*Cron) Manage ¶

func (c *Cron) Manage(runner cronenberg.Runner) error

Manage takes a Runner and schedules it as a Cron entry. If there are issues adding the Runner to the schedule, an error is returned. Otherwise, nil is returned.

type Runner ¶

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

Runner is an object that knows how to run a Job.

func (*Runner) Env ¶

func (runner *Runner) Env() map[string]string

Env returns the environment map for the Job that the Runner wraps.

func (*Runner) Name ¶

func (runner *Runner) Name() string

Name returns the name of the Job that the Runner wraps.

func (*Runner) Run ¶

func (runner *Runner) Run()

Run runs the wrapped Job's command. If the job is configured as a locking process, only one instance of that process will ever be run by a given Runner.

func (*Runner) Spec ¶

func (runner *Runner) Spec() string

Spec returns the cron schedule spec for the Job that the Runner wraps.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL