concurrent

Documentation

Overview

Package concurrent provides a simple way to run functions concurrently and then reap the results.

Package concurrent allows cuncurrent running of provided functions, by default limiting the parallelism to the number of CPUs. The functions return an error value and these may be reaped at the end.

Index

• type State
  • func NewState(numConcurrent uint) *State
  • func NewStateWithLinearConcurrencyIncrease(initialNumConcurrent uint, maximumNumConcurrent uint) *State
  • func (state *State) GoRun(doFunc func() error) error
  • func (state *State) Reap() error

Types

type State

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

State maintains state needed to manage running functions concurrently.

func NewState

func NewState(numConcurrent uint) *State

NewState returns a new State.

func NewStateWithLinearConcurrencyIncrease

func NewStateWithLinearConcurrencyIncrease(initialNumConcurrent uint,
	maximumNumConcurrent uint) *State

func (*State) GoRun

func (state *State) GoRun(doFunc func() error) error

GoRun will run the provided function in a goroutine. If the function returns a non-nil error, this will be returned in a future call to GoRun or by Reap. GoRun cannot be called concurrently with GoRun or Reap.

func (*State) Reap

func (state *State) Reap() error

Reap returns the first error encountered by the functions and waits for remaining functions to complete. The State can no longer be used after Reap.