worker

Documentation

Index

• Variables
• type DecorateFunction
• type Decorator
• type Registry
• type RegistryParams
• type RegistryResult
  • func NewRegistry(p RegistryParams) (RegistryResult, error)
• type Worker
  • func NewWorker(key string, hook fx.Hook) Worker

Variables

var ErrorNoWorkersEnabled = errors.New("no workers enabled")

Types

type DecorateFunction

type DecorateFunction func(fx.Hook) fx.Hook

type Decorator

type Decorator struct {
	Key      string
	Decorate DecorateFunction
}

type Registry

type Registry interface {
	Workers() []Worker
	Enable(names ...string) error
	Disable(names ...string) error
	EnableAll()
	DisableAll()
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	// contains filtered or unexported methods
}

type RegistryParams

type RegistryParams struct {
	fx.In
	fx.Shutdowner
	Workers    []Worker    `group:"workers"`
	Decorators []Decorator `group:"worker_decorators"`
	Logger     *zap.SugaredLogger
}

type RegistryResult

type RegistryResult struct {
	fx.Out
	Registry Registry
}

func NewRegistry

func NewRegistry(p RegistryParams) (RegistryResult, error)

type Worker

type Worker interface {
	Key() string
	Enabled() bool
	Started() bool
	// contains filtered or unexported methods
}

func NewWorker

func NewWorker(key string, hook fx.Hook) Worker