gowq

README

goWQ

A simple work queue manager to schedule jobs and then execute them on a defined pool of goroutines.

It can be used in two modes:

• static: allows to create a job queue and then run it waiting for all jobs to complete;
• dynamic: allows to run a job scheduler and then enqueue new jobs while the scheduler runs.

Examples

Static Queue Usage

wq := New[MyResult](2)

wq.Push(func(ctx context.Context) (MyResult, error) {
    // do something...
    return MyResult{}, nil
})
results, errors := wq.RunAll(context.TODO())

Dynamic Queue Manager

wq := New[MyResult](2)

go func(ctx context.Context) {
    wq.Start(ctx)
}(context.TODO())

wq.Schedule(func(ctx context.Context) (MyResult, error) {
    // do something...
    return nil
})

// Wait until all jobs have been completed.
_ := wq.Shutdown()

Documentation

Index

• Variables
• type DynamicScheduler
• type Job
• type JobResult
• type Queue
  • func New[Result JobResult](workers int) Queue[Result]
• type StaticScheduler

Variables

var (
	// ErrQueueNotStarted error used whenever an action is required on a dynamic queue
	// that has not been started yet.
	ErrQueueNotStarted = fmt.Errorf("Start must be called before")
	// ErrJobFailed error is used to wrap errors provided by failing jobs.
	ErrJobFailed = fmt.Errorf("job failed")
)

Types

type DynamicScheduler

type DynamicScheduler[Result JobResult] interface {
	Start(ctx context.Context)
	Schedule(job Job[Result])
	Shutdown() bool
}

type Job

type Job[T JobResult] func(context.Context) (T, error)

A Job is a simple function that should be executed in a limited set of routines.

type JobResult

type JobResult interface{}

type Queue

type Queue[Result JobResult] interface {
	GetResults() []Result
	GetErrors(flush bool) []error
	FlushErrors()
	DynamicScheduler[Result]
	StaticScheduler[Result]
}

func New

func New[Result JobResult](workers int) Queue[Result]

New creates a new WorkQueue instance to schedule jobs.

type StaticScheduler

type StaticScheduler[Result JobResult] interface {
	RunAll(context.Context) ([]Result, []error)
	Push(job Job[Result])
}