parallel

Documentation

Overview

The parallel package provides a way of running functions concurrently while limiting the maximum number running at once.

Index

• type Errors
  • func (errs Errors) Error() string
• type Run
  • func NewRun(maxPar int) *Run
  • func (r *Run) Do(f func() error)
  • func (r *Run) Wait() error

Types

type Errors

type Errors []error

Errors holds any errors encountered during the parallel run.

func (Errors) Error

func (errs Errors) Error() string

type Run

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

Run represents a number of functions running concurrently.

func NewRun

func NewRun(maxPar int) *Run

NewRun returns a new parallel instance. It will run up to maxPar functions concurrently.

func (*Run) Do

func (r *Run) Do(f func() error)

Do requests that r run f concurrently. If there are already the maximum number of functions running concurrently, it will block until one of them has completed. Do may itself be called concurrently.

func (*Run) Wait

func (r *Run) Wait() error

Wait marks the parallel instance as complete and waits for all the functions to complete. If any errors were encountered, it returns an Errors value describing all the errors in arbitrary order.