Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

queue

package

Go to main page

Versions in this module

v1

v1.12.1

Nov 6, 2026

v1.12.0

Nov 6, 2026

v1.11.1

Oct 29, 2026

v1.11.0

Oct 29, 2026

v1.10.1

Oct 20, 2026

v1.10.0

Oct 19, 2026

v1.9.0

Oct 13, 2026

Changes in this version

+ const DefaultAckedRetentionHours

+ const DefaultBackoffBase

+ const DefaultBackoffMax

+ const DefaultBatchSize

+ const DefaultConcurrency

+ const DefaultJanitorInterval

+ const DefaultLeaseDuration

+ const DefaultMaxAttempts

+ const DefaultMaxPayloadBytes

+ const DefaultPollInterval

+ const DefaultRetentionHours

+ const HeaderDeadLetterAttempts

+ const HeaderDeadLetterDeliveryID

+ const HeaderDeadLetterError

+ const HeaderDeadLetterGroup

+ const HeaderDeadLetterMessageID

+ const HeaderDeadLetterSourceTopic

+ const MaxIDLength

+ const MaxNameLength

+ var ErrClosed = errors.New("queue: closed")

+ var ErrDeadLetterLoop = errors.New("queue: dead letter topic is the subscribed topic")

+ var ErrInvalidName = errors.New("queue: invalid name")

+ var ErrNoLocker = errors.New("queue: distributed locker required")

+ var ErrPayloadTooLarge = errors.New("queue: payload too large")

+ var ErrScheduleTooFar = errors.New("queue: scheduled too far ahead")

+ var ErrUnsupported = errors.New("queue: unsupported")

+ func DeliveryID(messageID, group string) string

+ func IsPermanent(err error) bool

+ func NewProcessLocker() logstore.DistributedLocker

+ func Permanent(err error) error

+ func Register(t QueueType, f Factory)

+ func ValidateName(kind, name string) error

+ type ClaimRequest struct

+ Group string

+ Lease time.Duration

+ Max int

+ MaxInFlight int

+ RunnerID string

+ Topic string

+ type Claimed struct

+ Attempt int

+ ClaimToken string

+ DeliveryID string

+ Group string

+ Message *Message

+ type Config struct

+ Config any

+ Enabled bool

+ Type QueueType

+ func (c *Config) UnmarshalJSON(data []byte) error

+ type ConsumeChecker interface

+ CanConsume func() error

+ type Delivery struct

+ Attempt int

+ DeliveryID string

+ Group string

+ type Dependencies struct

+ Locker logstore.DistributedLocker

+ LogStore logstore.LogStore

+ type EngineConfig struct

+ AckedRetentionHours int

+ JanitorInterval string

+ MaxPayloadBytes int

+ RetentionHours int

+ func (c EngineConfig) Janitor() (time.Duration, error)

+ func (c EngineConfig) PurgePolicy() PurgePolicy

+ func (c EngineConfig) Retention() time.Duration

+ func (c EngineConfig) WithDefaults() EngineConfig

+ type Factory func(ctx context.Context, cfg *Config, deps Dependencies, logger schemas.Logger) (Queue, error)

+ type Handler func(ctx context.Context, d *Delivery) error

+ type LogStoreQueueConfig struct

+ type MemoryQueueConfig struct

+ type Message struct

+ DeliverAt time.Time

+ Headers map[string]string

+ ID string

+ Key string

+ Payload []byte

+ PublishedAt time.Time

+ Topic string

+ type Publisher interface

+ Publish func(ctx context.Context, msgs ...*Message) error

+ type PurgePolicy struct

+ AckedRetention time.Duration

+ DeadRetention time.Duration

+ type Queue interface

+ Close func(ctx context.Context) error

+ Ping func(ctx context.Context) error

+ Stats func(ctx context.Context, topic, group string) (Stats, error)

+ func NewQueue(ctx context.Context, cfg *Config, deps Dependencies, logger schemas.Logger) (Queue, error)

+ func NewStoreQueue(store Store, cfg EngineConfig, logger schemas.Logger) (Queue, error)

+ type QueueType string

+ const QueueTypeLogStore

+ const QueueTypeMemory

+ func Registered() []QueueType

+ type StartFrom string

+ const StartFromEarliest

+ const StartFromLatest

+ type Stats struct

+ Dead int64

+ Leased int64

+ Pending int64

+ type Store interface

+ Ack func(ctx context.Context, cs []*Claimed) ([]string, error)

+ Append func(ctx context.Context, msgs []*Message) error

+ Claim func(ctx context.Context, req ClaimRequest) ([]*Claimed, error)

+ Close func(ctx context.Context) error

+ EnsureGroup func(ctx context.Context, topic, group string, startFrom StartFrom) error

+ Extend func(ctx context.Context, cs []*Claimed, lease time.Duration) ([]string, error)

+ Kill func(ctx context.Context, c *Claimed, lastErr string) (bool, error)

+ Ping func(ctx context.Context) error

+ Purge func(ctx context.Context, policy PurgePolicy, batch int) (int64, error)

+ Release func(ctx context.Context, cs []*Claimed) error

+ Retry func(ctx context.Context, c *Claimed, backoff time.Duration, lastErr string) (bool, error)

+ Stats func(ctx context.Context, topic, group string) (Stats, error)

+ type SubscribeOption func(*SubscribeOptions)

+ func WithBackoff(base, max time.Duration) SubscribeOption

+ func WithBatchSize(n int) SubscribeOption

+ func WithConcurrency(n int) SubscribeOption

+ func WithDeadLetterTopic(topic string) SubscribeOption

+ func WithLeaseDuration(d time.Duration) SubscribeOption

+ func WithMaxAttempts(n int) SubscribeOption

+ func WithMaxInFlight(n int) SubscribeOption

+ func WithPollInterval(d time.Duration) SubscribeOption

+ func WithStartFrom(s StartFrom) SubscribeOption

+ type SubscribeOptions struct

+ BackoffBase time.Duration

+ BackoffMax time.Duration

+ BatchSize int

+ Concurrency int

+ DeadLetterTopic string

+ LeaseDuration time.Duration

+ MaxAttempts int

+ MaxInFlight int

+ PollInterval time.Duration

+ StartFrom StartFrom

+ func NewSubscribeOptions(opts ...SubscribeOption) (SubscribeOptions, error)

+ func (o SubscribeOptions) Backoff(attempt int, rnd func() float64) time.Duration

+ func (o SubscribeOptions) WithDefaults() SubscribeOptions

+ type Subscriber interface

+ Subscribe func(ctx context.Context, topic, group string, h Handler, opts ...SubscribeOption) (Subscription, error)

+ type Subscription interface

+ Close func(ctx context.Context) error

+ type WakeSource interface

+ Listen func(ctx context.Context, wake func(topic string)) error