runner

Documentation

Overview

Example is provided with help by Gabriel Aszalos. Package runner manages the running and lifetime of a process.

Index

• Variables
• type Runner
  • func New(d time.Duration) *Runner
  • func (r *Runner) Add(tasks ...func(int))
  • func (r *Runner) Start() error

Variables

var ErrInterrupt = errors.New("received interrupt")

ErrInterrupt is returned when an event from the OS is received.

var ErrTimeout = errors.New("received timeout")

ErrTimeout is returned when a value is received on the timeout channel.

Types

type Runner

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

Runner runs a set of tasks within a given timeout and can be shut down on an operating system interrupt.

func New

func New(d time.Duration) *Runner

New returns a new ready-to-use Runner.

func (*Runner) Add

func (r *Runner) Add(tasks ...func(int))

Add attaches tasks to the Runner. A task is a function that takes an int ID.

func (*Runner) Start

func (r *Runner) Start() error

Start runs all tasks and monitors channel events.