reerrgroup

Documentation

Overview

Package reerrgroup is a rewrite of errgroup

Index

• type Group
  • func WithContext(ctx context.Context, workerCount int) (*Group, context.Context)
  • func (g *Group) Go(f func() error)
  • func (g *Group) SetAfterTasks(f ...func() error)
  • func (g *Group) SetBeforeTasks(f ...func() error)
  • func (g *Group) TryGo(f func() error) bool
  • func (g *Group) Wait() error
  • func (g *Group) WaitTaskDone()

Types

type Group

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

A Group is a collection of goroutines working on subtasks that are part of the same overall task.

A zero Group is valid, has no limit on the number of active goroutines, and does not cancel on error.

func WithContext

func WithContext(ctx context.Context, workerCount int) (*Group, context.Context)

WithContext returns a new Group and an associated Context derived from ctx.

The derived Context is canceled the first time a function passed to Go returns a non-nil error or the first time Wait returns, whichever occurs first.

func (*Group) Go

func (g *Group) Go(f func() error)

Go calls the given function in a new goroutine. It blocks until the new goroutine can be added without the number of active goroutines in the group exceeding the configured limit.

The first call to return a non-nil error cancels the group's context, if the group was created by calling WithContext. The error will be returned by Wait.

func (*Group) SetAfterTasks

func (g *Group) SetAfterTasks(f ...func() error)

func (*Group) SetBeforeTasks

func (g *Group) SetBeforeTasks(f ...func() error)

func (*Group) TryGo

func (g *Group) TryGo(f func() error) bool

TryGo calls the given function in a new goroutine only if the number of active goroutines in the group is currently below the configured limit.

The return value reports whether the goroutine was started.

func (*Group) Wait

func (g *Group) Wait() error

Wait blocks until all function calls from the Go method have returned, then returns the first non-nil error (if any) from them.

func (*Group) WaitTaskDone

func (g *Group) WaitTaskDone()

WaitTaskDone only wait all task done without cancel ctx and close taskChan.