group

Documentation

Overview

Package group provides a simple interface to manage go routines.

Index

• Variables
• type Error
  • func Append(err error, errs ...error) *Error
  • func (e *Error) Error() string
• type Run
  • func WithContext(ctx context.Context) (*Run, context.Context)
  • func (g *Run) Run(f RunFunc) error
  • func (g *Run) SetLimit(n int)
  • func (g *Run) Shutdown() error
  • func (g *Run) Wait()
• type RunFunc
• type Unimplemented
  • func (s *Unimplemented) Run(context.Context, RunFunc) error

Variables

var ErrUnimplemented = errors.New("server: unimplemented")

ErrUnimplemented is returned when a listener is not implemented.

Types

type Error

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

Error ...

func Append

func Append(err error, errs ...error) *Error

Append ...

func (*Error) Error

func (e *Error) Error() string

Error ...

type Run

type Run struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Run is an abstraction on WaitGroup to run multiple functions concurrently. It mimics 'errgroup' to extend structs with functions to run concurrently with a root context.

func WithContext

func WithContext(ctx context.Context) (*Run, context.Context)

WithContext is creating a new group with a context.

func (*Run) Run

func (g *Run) Run(f RunFunc) error

Run is creating a new go routine to run a function concurrently.

func (*Run) SetLimit

func (g *Run) SetLimit(n int)

SetLimit limits the number of active listeners in this server

func (*Run) Shutdown

func (g *Run) Shutdown() error

Shutdown is waiting for all go routines to finish.

func (*Run) Wait

func (g *Run) Wait()

Wait is waiting for all go routines to finish.

type RunFunc

type RunFunc func(context.Context)

RunFunc is a function that is called to attach more routines to the server.

type Unimplemented

type Unimplemented struct{}

Unimplemented is the default implementation.

func (*Unimplemented) Run

func (s *Unimplemented) Run(context.Context, RunFunc) error

Run is running a new go routine