g

Documentation

Overview

Package g is a goroutine life cycle management package.

Index

• type G
  • func Go(f func() error) *G
  • func (g *G) Cancel() *G
  • func (g *G) Err() error
  • func (g *G) Wait() *G
  • func (g *G) WithUndo(undo func()) *G

Types

type G

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

G is a goroutine

func Go

func Go(f func() error) *G

Go runs a given f concurrently and returns a coresponding goroutine instance.

func (*G) Cancel

func (g *G) Cancel() *G

Cancel cancels the goroutine. Note that the goroutine does not get stopped and a good practice is to use Cancel with WithUndo function:

g := g.Go(func() error { ... }).WithUndo(func() { ... })
...
err := g.Cancel().Wait().Err()
if err != nil { ... }

Then the settled undo function will be executed after the cancellation.

func (*G) Err

func (g *G) Err() error

Err reports if the goroutine returns error, This call will wait until the goroutine terminates.

func (*G) Wait

func (g *G) Wait() *G

Wait wait until the goroutine terminates.

func (*G) WithUndo

func (g *G) WithUndo(undo func()) *G

WithUndo sets up a function that can be executed if a goroutine is canceled.