README
¶
gas/queue
Part of the Gas monorepo · Documentation · All modules
Job queues for the Gas framework, backed by AWS SQS. The interface is pull-based: consumers run their own loop and acknowledge with Ack or Nack.
Implements gas.JobQueueProvider.
go get github.com/gasmod/gas/queue
gas.WithSingletonService[gas.JobQueueProvider](sqs.New()),
sqs.New() needs gas.ConfigProvider and gas.Logger.
| Package | Provides |
|---|---|
queue/sqs |
AWS SQS, and ElasticMQ via a custom endpoint |
queue/queuetest |
Recording mock of gas.JobQueueProvider |
Documentation
The full guide, with configuration, testing, and worked examples, is on the docs site. This README is deliberately a signpost: keeping a second copy here is how the docs drifted before.
- Guide: Run background jobs
- API reference: pkg.go.dev/github.com/gasmod/gas/queue
- Contributing: CONTRIBUTING.md
License
Documentation
¶
Overview ¶
Package queue provides async job queue processing with AWS SQS. Concrete implementations live in the sqs sub-package.
See the module README for usage examples and design rationale.
SPDX-License-Identifier: MIT
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrClosed is returned when an operation is attempted on a closed // queue service. ErrClosed = errors.New("queue: service is closed") )
Sentinel errors returned by JobQueueProvider implementations.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package queuetest provides a mock implementation of gas.JobQueueProvider for use in tests.
|
Package queuetest provides a mock implementation of gas.JobQueueProvider for use in tests. |
|
Package sqs provides an AWS SQS job queue implementing gas.JobQueueProvider, with FIFO, delay and deduplication options, long-polling dequeue and custom endpoint support (e.g.
|
Package sqs provides an AWS SQS job queue implementing gas.JobQueueProvider, with FIFO, delay and deduplication options, long-polling dequeue and custom endpoint support (e.g. |