runner

Documentation

Index

• type Runner
  • func New(name string, logger *zap.Logger) *Runner
  • func (r *Runner) NumTasks() uint64
  • func (r *Runner) Run(f func(context.Context)) (context.CancelFunc, error)
  • func (r *Runner) RunC(ctx context.Context, f func(context.Context)) error
  • func (r *Runner) State() State
  • func (r *Runner) Stop()
  • func (r *Runner) String() string
  • func (r *Runner) WithManagedCancel(parent context.Context) (context.Context, context.CancelFunc)
• type State
  • func (i State) String() string

Types

type Runner

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

func New

func New(name string, logger *zap.Logger) *Runner

func (*Runner) NumTasks

func (r *Runner) NumTasks() uint64

func (*Runner) Run

func (r *Runner) Run(f func(context.Context)) (context.CancelFunc, error)

Run executes f in a goroutine. It returns context.CancelFunc and error.

func (*Runner) RunC

func (r *Runner) RunC(ctx context.Context, f func(context.Context)) error

func (*Runner) State

func (r *Runner) State() State

func (*Runner) Stop

func (r *Runner) Stop()

Stop stops tasks in this runner.

func (*Runner) String

func (r *Runner) String() string

func (*Runner) WithManagedCancel

func (r *Runner) WithManagedCancel(parent context.Context) (context.Context, context.CancelFunc)

WithManagedCancel returns a copy of parent with a new Done channel. The returned context's Done channel is closed when the returned cancel function is called or when the parent context's Done channel is closed, whichever happens first. Moreover, the returned context is managed by runner, thus, if the runner is stopped, the context is also canceled.

Canceling this context releases resources associated with it, so code should call cancel as soon as the operations running in this Context complete.

type State

type State int

const (
	Invalid State = iota
	Running
	Stopping
	Stopped
)

func (State) String

func (i State) String() string