background

Documentation

Index

• type Manager
  • func NewManager() Manager
• type Work

Types

type Manager

type Manager interface {
	// Start starts all registered background works.
	Start()
	// Stop starts all registered background works.
	Stop()
	// RegisterWork registers a background work against the Manager
	RegisterWorks(works ...Work) error
}

Manager allows multiple background Works to be registered and started/stopped together.

func NewManager

func NewManager() Manager

NewManager creates a new instance of Manager with registered background works.

type Work

type Work struct {
	Name         string
	Func         func(*atomic.Bool)
	Period       time.Duration
	InitialDelay time.Duration
}

Work refers to a piece of background work which needs to happen periodically.