errgroup

Documentation

Index

• type Group
  • func WithCancel(ctx context.Context) *Group
  • func WithContext(ctx context.Context) *Group
  • func WithTimeout(ctx context.Context, dur time.Duration) *Group
  • func (g *Group) GOMAXPROCS(n int)
  • func (g *Group) Go(f func(ctx context.Context) error)
  • func (g *Group) Wait() error
  • func (g *Group) WorkNum() int

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 and does not cancel on error.

func WithCancel

func WithCancel(ctx context.Context) *Group

WithCancel create a new Group and an associated Context derived from ctx. given function from Go will receive context derived from this 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 WithContext

func WithContext(ctx context.Context) *Group

WithContext create a Group. given function from Go will receive this context,

func WithTimeout

func WithTimeout(ctx context.Context, dur time.Duration) *Group

WithTimeout create a new Group and an associated Context derived from ctx. given function from Go will receive context derived from this ctx, The derived Context is canceled when the timeout expires

func (*Group) GOMAXPROCS

func (g *Group) GOMAXPROCS(n int)

GOMAXPROCS set max goroutine to work.

func (*Group) Go

func (g *Group) Go(f func(ctx context.Context) error)

Go calls the given function in a new goroutine. The first call to return a non-nil error cancels the group; its error will be returned by Wait.

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) WorkNum

func (g *Group) WorkNum() int