worker

package

v0.20.0 Latest Latest Go to latest Published: Mar 16, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

func Parallel(ctx context.Context, workers ...Worker) error

Parallel executes a set of Workers and waits for them to finish.

type Worker func(context.Context) error

Worker is a function that WorkerGroup will run in a new goroutine.

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

WorkerGroup is similar in principle to sync.WaitGroup but manages the Workers itself. This allows it to provide a few helpful features:

func NewWorkerGroup(ctx context.Context, workerLimit int) *WorkerGroup

NewWorkerGroup creates a new group.

func (wg *WorkerGroup) Start(worker Worker) error

Start launches a new worker, blocking if too many workers are already running. An error indicates the group's context is closed.

func (wg *WorkerGroup) Wait() error

Wait blocks until all running workers have finished. An error indicates if at least one worker returned an error or was canceled.

func (wg *WorkerGroup) WaitError(err error) error

Wait with a default error value that will be returned if no worker failed.

if err := wg.Start(worker); err != nil {
	return wg.WaitError(err)
}