errgroup

README

errgroup

中文文档

The errgroup package is an extension of the sync/errgroup package, and its core is to manage the behavior of a set of gotoutines. Control the behavior of other goroutines in the group when error or panic occurs: cancel all executions or continue all executions.

Install

go get -u github.com/fanjindong/errgroup

Fast Start

errgroup contains three common methods

1. NewContinue At this point, all tasks will not be cancelled because one task failed

eg := &errgroup.NewContinue(ctx)
eg.Go(func (ctx context.Context) {
    // NOTE: In this case, ctx is the ctx passed by NewContinue
    // do something
})
eg.Wait()

1. NewCancel If one task fails, all pending or ongoing tasks will be cancelled

eg := errgroup.NewCancel(ctx)
eg.Go(func (ctx context.Context) {
    // NOTE: At this point ctx is derived from the ctx passed in WithContext
    // do something
})
eg.Wait()

1. Setting the maximum number of parallelism SetMaxProcess works for all the above uses

eg := errgroup.NewCancel(ctx, WithMaxProcess(2))
// task1
eg.Go(func(ctx context.Context) {
    fmt.Println("task1")
})
// task2
eg.Go(func (ctx context.Context) {
    fmt.Println("task2")
})
// task3
eg.Go(func (ctx context.Context) {
    fmt.Println("task3")
})
eg.Wait()
// NOTE: At this point, WithMaxProcess is set to 2,
// Added task1, task2, task3 ,
// Initially, only two tasks will run, and the last task will not be executed until one task is complete.

Example

• simple

Documentation

Index

• type CancelGroup
  • func (g *CancelGroup) Go(f fc)
  • func (g *CancelGroup) Wait() error
• type ContinueGroup
  • func (g *ContinueGroup) Go(f fc)
  • func (g *ContinueGroup) Wait() error
• type IGroup
  • func NewCancel(ctx context.Context, ops ...IOption) IGroup
  • func NewContinue(ctx context.Context, ops ...IOption) IGroup
• type IOption
  • func WithIgnoreErr(f func(err error) bool) IOption
  • func WithMaxProcess(n int) IOption

Types

type CancelGroup

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

func (*CancelGroup) Go

func (g *CancelGroup) Go(f fc)

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 (*CancelGroup) Wait

func (g *CancelGroup) 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.

type ContinueGroup

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

func (*ContinueGroup) Go

func (g *ContinueGroup) Go(f fc)

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 (*ContinueGroup) Wait

func (g *ContinueGroup) 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.

type IGroup

type IGroup interface {
	Go(fc)
	Wait() error
}

func NewCancel

func NewCancel(ctx context.Context, ops ...IOption) IGroup

func NewContinue

func NewContinue(ctx context.Context, ops ...IOption) IGroup

type IOption

type IOption func(conf *config)

func WithIgnoreErr

func WithIgnoreErr(f func(err error) bool) IOption

func WithMaxProcess

func WithMaxProcess(n int) IOption