queue

package

v1.9.1 Latest Latest Go to latest Published: Mar 20, 2021 License: MIT Imports: 4 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

Package queue contains a simple job queue implementation for running concurrent jobs.

This section is empty.

This section is empty.

This section is empty.

type Job struct {
	ID string
}

The Job type represents a single unit of work.

type Option func(c *config)

The Option type is a function that modifies the queue configuration.

func MaxWorkers(max int) Option

MaxWorkers specifies the maximum amount of concurrent jobs that the queue can process.

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

The Queue type is responsible for queueing and executing concurrent jobs.

func New(ctx context.Context, wf WorkFunc, opts ...Option) *Queue

New creates a new *Queue instance with the specified configuration options.

func (q *Queue) Add(ctx context.Context, job Job) error

Add a job to the queue.

func (q *Queue) Errors() <-chan error

Errors exposes the errors channel for reading.

type WorkFunc func(ctx context.Context, j Job) error

WorkFunc is a function invoked for each job.