executor

Documentation

Index

• type Config
• type Executor
  • func New(c Config) (*Executor, error)
  • func (e *Executor) AddJob(j Job) error
  • func (e *Executor) RunJobs(ctx context.Context)
  • func (e *Executor) Shutdown() bool
• type Job

Types

type Config

type Config struct {
	QueueSize            int
	Workers              int
	MaxJobRetries        int
	BaseRetryDelay       time.Duration
	RetryJobAfterFailure bool
	PerWorkerQPS         int
	Timeout              time.Duration
}

Config is the config for executor

type Executor

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

Executor is a rate-limited work queue with concurrent workers.

func New

func New(c Config) (*Executor, error)

New creates a new Executor with a queue size, number of workers, and a job-running or shutdown timeout.

func (*Executor) AddJob

func (e *Executor) AddJob(j Job) error

AddJob adds a job to the queue.

func (*Executor) RunJobs

func (e *Executor) RunJobs(ctx context.Context)

RunJobs starts workers.

func (*Executor) Shutdown

func (e *Executor) Shutdown() bool

Shutdown stops workers.

type Job

type Job interface {
	Type() string
	ID() string
	Run(ctx context.Context) error
	AllowConcurrency() bool
}

Job is an Action to be executed by the workers in the Executor.