queue

Documentation

Overview

Package queue defines the platform work-queue contract and its outbox-backed implementation.

Index

• Variables
• type OutboxQueue
  • func NewOutboxQueue(publisher outbox.Outbox) *OutboxQueue
  • func (q *OutboxQueue) Enqueue(ctx context.Context, t Task) error
• type Queue
• type Task

Variables

var Module = fx.Options(
	fx.Provide(fx.Annotate(NewOutboxQueue, fx.As(new(Queue)))),
)

Module provides the outbox-backed queue as the Queue contract.

Types

type OutboxQueue

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

OutboxQueue implements Queue by reusing the outbox publisher: a Task has the same Subject()/Version() shape as an OutboxEvent, so the outbox row layout already fits. The relay routes by subject (events.* vs queue.*) to the appropriate JetStream stream.

func NewOutboxQueue

func NewOutboxQueue(publisher outbox.Outbox) *OutboxQueue

func (*OutboxQueue) Enqueue

func (q *OutboxQueue) Enqueue(ctx context.Context, t Task) error

Enqueue stages a task for at-least-once, single-consumer execution. MUST be called inside a UnitOfWork transaction so the outbox row write is atomic with the aggregate state change that triggered the enqueue.

type Queue

type Queue interface {
	Enqueue(ctx context.Context, t Task) error
}

Queue enqueues tasks for asynchronous execution.

type Task

type Task interface {
	Subject() string
	Version() string
}

Task is the constraint for queueable point-to-point work units. Each task type declares its own subject and schema version. Tasks are imperative ("validate-asset"), single-consumer, and live on the work-queue stream.