runman

Documentation

Overview

Package runman provides manager that can run a bunch of Runner interface implementations concurrently. When one of the runners finishes, all other ones will be canceled via context. You can also cancel them all prematurely by canceling passed context.

Typical usage:

runman.New(runner1, runner2, runner3).Run(ctx)

Index

• type Manager
  • func New(runners ...Runner) *Manager
  • func (m *Manager) Run(ctx context.Context)
• type Runner

Types

type Manager

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

Manager structure used to manage a list of runners. Note that it implements Runner interface too, so in theory you can feed one manager instance into another.

func New

func New(runners ...Runner) *Manager

New function creates new manager instance with a list of provided runners.

func (*Manager) Run

func (m *Manager) Run(ctx context.Context)

Run method runs all runners in separate goroutines. When one of them finishes, all other will be canceled. When provided context cancels, all runners are canceled too. It returns only when everything finishes.

type Runner

type Runner interface {
	Run(ctx context.Context)
}

Runner interface, implementations of which are managed by Manager structure.