limitgroup

package module

v1.0.0 Latest Latest Go to latest Published: Nov 29, 2018 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bsm/limitgroup

Links

Open Source Insights

README ¶

LimitGroup

An errgroup with concurrency limits.

Documentation ¶

Overview ¶

Package limitgroup provides a control structure for a group of goroutines with configurable concurrency (max number of goroutines to run in parallel).

Index ¶

type Group
- func New(ctx context.Context, concurrency int) (*Group, context.Context)
- func (g *Group) Go(fn func() error)
- func (g *Group) Wait() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Group ¶

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

Group is a concurrency-limiting errgroup.

func New ¶

func New(ctx context.Context, concurrency int) (*Group, context.Context)

New inits a new group with a given concurrency (default: 1).

func (*Group) Go ¶

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

Go runs a function as part of the group. If group's context is cancelled, this is a no-op.

func (*Group) Wait ¶

func (g *Group) Wait() error

Wait waits for all the group functions to exit and returns the first error.

Source Files ¶

View all Source files

limitgroup.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL