group

Documentation

Overview

Group package provides a way to manage a group of goroutines.

Index

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

Types

type Group

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

Group 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 ...Opt) *Group

New creates a new group.

func (*Group) Add

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

Add is adding a new goroutine to the group.

func (*Group) Wait

func (g *Group) Wait() error

Wait is a blocking call that waits for all goroutines to exit.

type Opt

type Opt func(*Group)

Opt is an option for the routine group

func WithContext

func WithContext(ctx context.Context) Opt

WithContext uses the provided context for the group.