group

README

Group

A group provides a way manage the lifetime of a group of related goroutines.

Documentation

Overview

package group provides a way to manage the lifecycle of a group of goroutines.

Index

• type G
  • func New(opts ...Option) *G
  • func (g *G) Add(fn func(context.Context) error)
  • func (g *G) Wait() error
• type Option
  • func WithContext(ctx context.Context) Option

Types

type G

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

G manages the lifetime of a set of goroutines from a common context. The first goroutine in the group to return will cause the context to be canceled, terminating the remaining goroutines.

func New

func New(opts ...Option) *G

New creates a new group.

func (*G) Add

func (g *G) Add(fn func(context.Context) error)

add adds a new goroutine to the group. The goroutine should exit when the context passed to it is canceled.

func (*G) Wait

func (g *G) Wait() error

wait waits for all goroutines in the group to exit. If any of the goroutines fail with an error, wait will return the first error. Wait waits for all goroutines in the group to exit. If any of the goroutines fail with an error, Wait will return the first error.

type Option

type Option func(*G)

func WithContext

func WithContext(ctx context.Context) Option

WithContext uses the provided context for the group.