Arbiter.Worker

Run a worker pool until shutdownWorkerPool, then drain within gracefulShutdownTimeout. Throws WorkerConfigException for an invalid config.

Name a pool from its payload's registry entry.

A single-stripe connection pool sized for the enabled pools' threads and the listener. Unset or blank ARBITER_ENABLED_QUEUES enables all queues. Throws WorkerConfigException for an invalid enabled pool config, and InternalException when ARBITER_ENABLED_QUEUES has an unknown name or names no queues.

Run only named pools. A pool that exits winds down its peers. After every peer has been joined, the failure of the first failed pool in list order is rethrown. Throws WorkerPoolSelectionException for a name with no pool, or when no pool is selected.

Run the pools selected by ARBITER_ENABLED_QUEUES, or every configured pool when it is unset or blank. Throws InternalException when ARBITER_ENABLED_QUEUES has an unknown name or names no queues, and WorkerPoolSelectionException for a selected queue with no pool, or when no pool is selected.

Signal graceful shutdown to every pool atomically.

A worker pool paired with its registry-derived queue name.

A requested queue has no configured pool, or selection is empty.

Validated, comma-separated queue names from ARBITER_ENABLED_QUEUES. Unset or blank selects all registered queues. Unknown names, or a value that names no queues, throw InternalException.

A rollup parent's immediate child results, keyed by child id, and its DLQ errors, keyed by DLQ row id for retryFromDLQ. A Left is a DLQ child's error or a decode failure.

childResults with successfully decoded values combined through Monoid.

Combine successful child results. A Left counts as mempty.

Store a job's result for its parent rollup. A root job's result goes on its archive entry only when its archiveFor is positive. The archive entry exists only after the job's ack.

storeJobResult on an already-encoded result. Nothing stores nothing.

Configuration for a worker pool.

Create a WorkerConfig running one job per group in a worker transaction held for the duration of the handler.

Create a WorkerConfig that passes one job per handler call, no worker transaction. The handler finalizes the job through BatchCallbacks.

Create a WorkerConfig for batched job processing, no worker transaction. The handler receives the batch and a BatchCallbacks record to finalize each job. To store a result per job, ack with ackWith or ackAllWith.

Transform a pool's observability hooks.

Run report before the pool's own maintenance callback. Each runs even when the other fails.

Job claim and handler mode. Set by transactionalWorkerConfig, manualWorkerConfig and batchedWorkerConfig.

The maximum jobs in a batch. A batch is one group, or ungrouped jobs.

The result type declared by payload's registry entry. It is not injective. A signature naming it needs another argument to determine payload.

Invalid worker configuration detected before a pool starts.

Validate all invariants required for safe worker execution. Return all violations.

Gap the bucket prune and the concurrency reconcile-and-prune keep.

Age after which an idle rate-limit bucket is pruned.

Statement timeout for one maintenance operation.

Per-job finalizers passed to a batched handler. When the handler returns, untouched jobs are reprocessed after the lease expires, and their attempt is used. When it throws, untouched jobs fail. A JobNackException releases them with their attempt restored. A JobScopedFailure that names jobs in the batch fails only those jobs. A JobGoneException that names jobs in the batch reports only those jobs as unavailable, or as cancelled after a force-cancel. Both release the rest. The With variants store a result for the job's parent rollup or its archive entry.

Each callback commits in its own transaction. Inside withDbTransaction, it runs as a savepoint in the outer transaction. The success hook fires at savepoint release. An outer rollback reprocesses the job after its lease expires.

ack, ackWith and spawn abort the handler if another worker holds the job. The abort nacks the siblings still unfinalized.

Callbacks for m, called from n through the given natural transformation. It must be a monad morphism that keeps the worker's connection and schema. Each callback then joins the handler's transaction.

A worker pool's effective state, read off the shutdown and pause flags on its WorkerConfig. Shutdown wins, then pause, then running.

Mutable state owned by one worker pool. The config constructors allocate it.

Initiate graceful shutdown of the worker pool.

Stops claiming new jobs. In-flight jobs get up to gracefulShutdownTimeout to finish. Then the pool exits.

The pool's state, with a pause reported as paused.

Whether this pool's LISTEN channels are subscribed (or there is no listener).

getWorkerState inside STM.

Worker log level, destination, and context.

Where Arbiter writes log output.

Default log configuration: Info level to stdout, no additional context.

Silent log configuration: discards all logs.

Log severity levels.

A key/value pair for an Object.

One pass of the maintenance the reaper runs, with each operation independently gated across all callers. An operation whose window has not elapsed is skipped. The pass covers every queue in the schema (schemaQueues), not only the caller's registry. Which caller wins a gate does not change the result. Returns the operations that threw. A failure for one queue is logged and not returned. A failure does not stop the pass. When the schema's queues cannot be read, no operation runs and every operation is returned.

Gaps between runs of each kind of work, and the bucket idle age. A zero gap runs that work every pass.

Which reaper op a maintenance report came from.

The op's stable name, used to coordinate replicas and to label its metrics.

A cron schedule. Built with cronJob, or cronJobInTimezone for a non-UTC one.

Cron tick overlap policy.

Bound on replay of missed ticks. Applies at startup and mid-flight.

Whether a tick is for the current minute or a replay of a past minute.

Build a CronJob evaluated in UTC. A bad expression returns Left. cronJobInTimezone is the local-time form. Set backfill and initiallyEnabled by record update.

cronJob "nightly-report" "0 3 * * *" SkipOverlap
  (\_kind _tick -> defaultJob (GenerateReport "nightly"))

Like cronJob but evaluated in a specific timezone. The tz name is validated eagerly against the bundled tzdata database.

Convert an OverlapPolicy to its text representation.

Parse an OverlapPolicy from text.

Check a cron patch before it is written. At tick time a bad override stops firing or falls back to the default.

updateCronScheduleUnchecked behind validateCronScheduleUpdate. Returns rows affected, 0 for an unknown name or an empty patch.