background

Documentation

Index

• type Background
  • func New(log logrus.FieldLogger) *Background
  • func (bg *Background) Add(f func() error)
  • func (bg *Background) Shutdown(ctx context.Context) error

Types

type Background

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

Background is a container of concurrently executed tasks. It handles tasks's errors by logging them. It also recovers in case of panics.

func New

func New(log logrus.FieldLogger) *Background

New constructs and returns a new Background.

func (*Background) Add

func (bg *Background) Add(f func() error)

Add inserts a new task, which will be executed in background.

func (*Background) Shutdown

func (bg *Background) Shutdown(ctx context.Context) error

Shutdown waits for tasks to complete. If the passed context expires then it returns an error indicating that some task didn't terminate in time.