parallelizer

Documentation

Overview

Package parallelizer features some utilities to help run tasks in parallel.

Index

• Constants
• func NewParallelizer(workers int) *parallelizer
• type ErrorFlag
  • func NewErrorFlag() *ErrorFlag
  • func (f *ErrorFlag) Lower() error
  • func (f *ErrorFlag) Raise(err error)
• type Parallelizer

Constants

const (
	// The default number of workers.
	DefaultNumOfWorkers = 4
)

Functions

func NewParallelizer

func NewParallelizer(workers int) *parallelizer

NewParallelizer returns a parallelizer for running tasks in parallel.

Types

type ErrorFlag

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

ErrorFlag is a flag for indicating whether an error has occurred when running tasks in parallel with the parallelizer.

func NewErrorFlag

func NewErrorFlag() *ErrorFlag

NewErrorFlag returns an error flag.

func (*ErrorFlag) Lower

func (f *ErrorFlag) Lower() error

Lower lowers the error flag and returns the error that was used to raise the flag; it returns nil if the flag has not been raised.

func (*ErrorFlag) Raise

func (f *ErrorFlag) Raise(err error)

Raise raises the error flag with an error; if the flag has been raised, it will return immediately.

type Parallelizer

type Parallelizer interface {
	// ParallelizeUntil runs tasks in parallel, wrapping workqueue.ParallelizeUntil.
	ParallelizeUntil(ctx context.Context, pieces int, doWork workqueue.DoWorkPieceFunc, operation string)
}

Parallelizer helps run tasks in parallel.