executor

executor

import "github.com/carousell/Orion/utils/executor"

• Overview
• Imported Packages
• Index

Overview

Imported Packages

No packages beyond the Go standard library are imported.

Index

• type Executor
  • func NewExecutor(options ...Option) Executor
• type Option
  • func WithConcurrency(n int) Option
  • func WithFailOnError(fail bool) Option
• type Task

Package files

executor.go types.go

type Executor

type Executor interface {
    //Add adds a task to executor queue
    Add(task Task)
    //Wait waits for all executors to finish or one of them to error based on option selected
    Wait() error
}

Executor is the interface for a basic executor pipeline

func NewExecutor

func NewExecutor(options ...Option) Executor

NewExecutor builds and returns an executor

type Option

type Option func(*config)

Option represents different options available for Executor

func WithConcurrency

func WithConcurrency(n int) Option

WithConcurrency sets the number of concurrent works

func WithFailOnError

func WithFailOnError(fail bool) Option

WithFailOnError fails all task if even a single task returns a error

type Task

type Task func() error

Task is the basic task that gets executed in executor

Generated by godoc2ghmd