queue

package

Go to main page

Versions in this module

v0

v0.0.13

Oct 12, 2026

Changes in this version

+ func IsAbort(err error) bool

+ func LastAttempt(ctx context.Context) bool

+ func WillRetry(ctx context.Context, err error) bool

v0.0.12

Oct 11, 2026

v0.0.11

Sep 24, 2026

v0.0.10

Sep 24, 2026

Changes in this version

type EnqueueOption

+ func CoalesceKey(k string) EnqueueOption

type Runtime

+ func (r *Runtime) TxProducerVia[TTx any](store driver.TxStore[TTx]) (*TxProducerClient[TTx], error)

v0.0.9

Sep 24, 2026

Changes in this version

type Runtime

+ func (r *Runtime) TxProducer[TTx any]() (*TxProducerClient[TTx], error)

type Worker

+ func (w *Worker) RegisterKind(kind string, handler func(ctx context.Context, payload json.RawMessage) error, ...) error

+ func (w *Worker) Register[T JobArgs](handler func(ctx context.Context, args T) error, opts ...RegisterOption) error

v0.0.8

Jul 31, 2026

v0.0.7

Jul 28, 2026

Changes in this version

type JobView

+ StartedAt time.Time

v0.0.6

Jul 27, 2026

Changes in this version

type Manager

+ func (m *Manager) RunNow(ctx context.Context, id uuid.UUID) error

v0.0.5

Jul 26, 2026

v0.0.4

Jul 26, 2026

Changes in this version

type Option

+ func WithDeadRetention(d time.Duration) Option

type Worker

+ func (w *Worker) Wait(ctx context.Context) error

v0.0.3

Jul 26, 2026

v0.0.2

Jul 25, 2026

v0.0.1

Jul 25, 2026

Changes in this version

+ const StateActive

+ const StateDead

+ const StatePaused

+ const StatePending

+ const StateScheduled

+ const StateSucceeded

+ func Abort(err error) error

+ func Attempt(ctx context.Context) int

+ func EnqueuedAt(ctx context.Context) time.Time

+ func IsNotFound(err error) bool

+ func IsRetry(ctx context.Context) bool

+ func JobID(ctx context.Context) uuid.UUID

+ func Kind(ctx context.Context) string

+ func MaxAttempts(ctx context.Context) int

+ func Metadata(ctx context.Context) map[string]string

+ func NewContext(parent context.Context, j JobInfo) context.Context

+ func RegisterKind(w *Worker, kind string, ...) error

+ func Register[T JobArgs](w *Worker, handler func(ctx context.Context, args T) error, ...) error

+ func Reportable(err error) error

+ func Retry(err error) error

+ func RetryAfter(err error, d time.Duration) error

+ type AttemptError = driver.AttemptError

+ type DailyCount = driver.DailyCount

+ type EnqueueOption func(*enqueueOptions)

+ func At(t time.Time) EnqueueOption

+ func Delay(d time.Duration) EnqueueOption

+ func IdempotencyKey(k string) EnqueueOption

+ func IdempotencyKeyTTL(k string, window time.Duration) EnqueueOption

+ func MaxRetries(n int) EnqueueOption

+ func Meta(key, value string) EnqueueOption

+ type EnqueueResult struct

+ Deduplicated bool

+ ID uuid.UUID

+ type JobArgs interface

+ Kind func() string

+ type JobInfo struct

+ Attempt int

+ EnqueuedAt time.Time

+ ID uuid.UUID

+ Kind string

+ MaxAttempts int

+ Meta map[string]string

+ func JobFromContext(ctx context.Context) (JobInfo, bool)

+ type JobListPage struct

+ Items []JobView

+ Page int

+ Size int

+ Total int64

+ type JobState = driver.JobState

+ type JobView struct

+ Attempt int

+ CompletedAt time.Time

+ EnqueuedAt time.Time

+ FailedAt time.Time

+ ID uuid.UUID

+ Kind string

+ LastError string

+ LeaseDeadline time.Time

+ MaxAttempts int

+ Meta map[string]string

+ Payload []byte

+ RunAt time.Time

+ State JobState

+ TraceID string

+ type Manager struct

+ func (m *Manager) AllStats(ctx context.Context) (QueueStats, error)

+ func (m *Manager) Archive(ctx context.Context, id uuid.UUID) error

+ func (m *Manager) Delete(ctx context.Context, id uuid.UUID, state JobState) error

+ func (m *Manager) Get(ctx context.Context, id uuid.UUID) (*JobView, error)

+ func (m *Manager) JobAttempts(ctx context.Context, id uuid.UUID) ([]AttemptError, error)

+ func (m *Manager) List(ctx context.Context, queue string, state JobState, page, size int) (JobListPage, error)

+ func (m *Manager) ListAllJobs(ctx context.Context, state JobState, page, size int) (JobListPage, error)

+ func (m *Manager) ListQueues(ctx context.Context) ([]QueueInfo, error)

+ func (m *Manager) NukeAll(ctx context.Context) (NukeReport, error)

+ func (m *Manager) Pause(ctx context.Context, id uuid.UUID) error

+ func (m *Manager) Purge(ctx context.Context, queue string) (PurgeReport, error)

+ func (m *Manager) Resume(ctx context.Context, id uuid.UUID) error

+ func (m *Manager) Retry(ctx context.Context, id uuid.UUID) error

+ func (m *Manager) RetryAll(ctx context.Context, queue string) (int64, error)

+ func (m *Manager) Stats(ctx context.Context, queue string) (QueueStats, error)

+ func (m *Manager) VacuumDead(ctx context.Context, queue string, olderThan time.Duration) (int64, error)

+ type NukeReport = driver.NukeReport

+ type Option func(*config) error

+ func WithCompletedRetention(d time.Duration) Option

+ func WithCoreOptions(opts ...azync.Option) Option

+ func WithCron(enabled bool) Option

+ func WithCronTick(d time.Duration) Option

+ func WithDefaultConcurrency(n int) Option

+ func WithDefaultJobTimeout(d time.Duration) Option

+ func WithDefaultMaxRetries(n int) Option

+ func WithFetchBatchSize(n int) Option

+ func WithFetchCooldown(d time.Duration) Option

+ func WithFetchPollInterval(d time.Duration) Option

+ func WithIdleBackoffMax(d time.Duration) Option

+ func WithLeaseTTL(d time.Duration) Option

+ func WithMaxConcurrency(n int) Option

+ func WithMaxReaps(n int) Option

+ func WithShutdownDrain(d time.Duration) Option

+ func WithStatsRetention(d time.Duration) Option

+ type Producer struct

+ func (p *Producer) Enqueue(ctx context.Context, args JobArgs, opts ...EnqueueOption) (EnqueueResult, error)

+ type PurgeReport struct

+ ActiveRemaining int64

+ Dead int64

+ Pending int64

+ Scheduled int64

+ type QueueInfo struct

+ Active int64

+ Dead int64

+ Name string

+ Namespace string

+ Paused int64

+ Pending int64

+ Scheduled int64

+ Succeeded int64

+ type QueueStats struct

+ Active int64

+ Daily []DailyCount

+ Dead int64

+ Enqueued int64

+ Failed int64

+ Paused int64

+ Pending int64

+ Processed int64

+ Queue string

+ Reaped int64

+ Scheduled int64

+ Succeeded int64

+ WindowDays int

+ type RegisterOption func(*registerOptions)

+ func WithConcurrency(n int) RegisterOption

+ func WithJobTimeout(d time.Duration) RegisterOption

+ func WithMaxRetries(n int) RegisterOption

+ type Runtime struct

+ func New(core *azync.Core, opts ...Option) (*Runtime, error)

+ func Open(dsn string, opts ...Option) (*Runtime, error)

+ func (r *Runtime) Close(ctx context.Context) error

+ func (r *Runtime) Manager() *Manager

+ func (r *Runtime) Migrate(ctx context.Context) error

+ func (r *Runtime) Producer() *Producer

+ func (r *Runtime) Worker() *Worker

+ type TxProducerClient struct

+ func TxProducer[TTx any](r *Runtime) (*TxProducerClient[TTx], error)

+ func (c *TxProducerClient[TTx]) EnqueueTx(ctx context.Context, tx TTx, args JobArgs, opts ...EnqueueOption) (EnqueueResult, error)

+ type Worker struct

+ func (w *Worker) Ready() <-chan struct{}

+ func (w *Worker) RegisterCron(name, spec string, args JobArgs, opts ...EnqueueOption) error

+ func (w *Worker) Start(ctx context.Context) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL