utils

Documentation

Overview

Package utils provides various utility functions.

Index

• Variables
• type Runner
  • func NewRunner(fn, stop func() error, retryStop func(error) bool) *Runner
  • func (r *Runner) Run() error
  • func (r *Runner) Stop() error

Variables

var (
	// ErrAlreadyRunning is the error that is returned when runner is already running/closing/closed.
	ErrAlreadyRunning = errors.New("runner is already running/closing/closed")
	// ErrNotRunning is the error that is returned when runner is not running/closing/closed.
	ErrNotRunning = errors.New("runner is not running/closing/closed")
)

Types

type Runner

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

Runner is a fn/stop runner.

func NewRunner

func NewRunner(fn, stop func() error, retryStop func(error) bool) *Runner

NewRunner creates a new runner.

func (*Runner) Run

func (r *Runner) Run() error

Run runs fn.

func (*Runner) Stop

func (r *Runner) Stop() error

Stop stops runner. It's safe to call even if runner is already stopped or in process of being stopped.