controller

Documentation

Index

• type Configuration
  • func DefaultConfigWithFlags() (*Configuration, []cli.Flag)
  • func (c *Configuration) Validate() error
• type Controller
  • func New(cfg *Configuration, integration integrations.Runner, consumer *run.Consumer) (*Controller, error)
  • func (c *Controller) Run(parent context.Context) error

Types

type Configuration

type Configuration struct {
	ScratchDir string
	Workers    int
}

Configuration encapsulates information used by the control loop.

func DefaultConfigWithFlags

func DefaultConfigWithFlags() (*Configuration, []cli.Flag)

DefaultConfigWithFlags returns configuration and flags specific to the control loop.

func (*Configuration) Validate

func (c *Configuration) Validate() error

Validate ensures the configuration provided contains the required information.

type Controller

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

Controller encapsulates the logic of spinning up multiple workers to feed from a common integration

func New

func New(
	cfg *Configuration,
	integration integrations.Runner,
	consumer *run.Consumer,
) (*Controller, error)

New returns a new controller that manages the pipeline between the integration and the consumers

func (*Controller) Run

func (c *Controller) Run(parent context.Context) error

Run performs a single pass over the data.