dispatcher

package

v0.20.2 Latest Latest Go to latest Published: Jun 21, 2023 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Dispatcher is the central place which runs Pipelines. maxWorkers is based by default on number of CPUs * 2 accounting for modern CPU architectures.

func New() *Dispatcher

New returns a set up instance of Dispatcher

func (dispatch *Dispatcher) RunPipelines(pipelines []Pipeliner) *Results

RunPipelines will run asynchronously all pipelines passed to it. It is limited only by the maxWorkers field on Dispatcher.

type FailureData struct {
	Name  string
	Value string
}

FailureData is used to build the table output Example: "hash": "somehash". It is built as a struct to enforce order

type PipelineError struct {
	PipelineName string
	Data         []FailureData
	Error        error
}

PipelineError is used to group errors based on PipelineName

type PipelineSuccess struct {
	PipelineName string
	Message      string
}

PipelineSuccess is returned by a pipeline if it encounters no errors

type Pipeliner interface {
	Name() string
	Run() (*PipelineSuccess, error)
}

Pipeliner interface describes the requirements for pipelines the dispatcher can run

type Results struct {
	SuccessfulPipelines []PipelineSuccess
	Errors              []PipelineError
}

Results contains the aggregated results of both the succesful and error pipelines.