Arbiter.Core.Job.Types

A job parametrized over payload, primary key, queue name, insertion timestamp, and the columns derived from the payload. The constructor is internal.

A payload's per-job variant label. With no instance, the job is unlabelled. An empty instance on a Generic payload labels it with the constructor name.

A value's constructor name, for a payload that wraps a sum. Requires Generic.

instance HasKind Envelope where
  kindOf = Just . constructorKind . envelopePayload
  kindsFor = constructorKinds @EmailPayload

Every constructor name of a type, in declaration order.

The labels and keys a stored job carries from its payload, one field each.

A job read from the database.

A job's JSON fields as key-value pairs.

A job's JSON fields as an encoding series.

A payload as the JSON bytes the database holds. The type it decodes to is a phantom.

The JSON bytes of a stored payload.

A payload's stored form.

Decode a stored payload, or the reason the type rejects it.

A job ready to enqueue. Arbiter owns claim, retry, parent, rollup, and suspension state. Use the exported setters to configure enqueue fields.

A job's primary key.

The token identifying one claim of a job.

Database-assigned identifier for a stored job.

User-defined payload stored as JSONB.

Queue containing a stored job.

Serial-processing group, or Nothing for an ungrouped job.

Time at which the job was inserted.

Time at which the job was last updated.

Number of attempts made so far.

Error message from the last failed attempt.

Claim priority. Lower numbers have higher priority. In a group, a retried job goes first.

Time at which a worker last claimed the job.

Earliest time at which the job can be claimed.

Deduplication strategy and key.

Attempt limit before the job moves to the DLQ.

Identifier of this job's parent in a job tree.

Snapshot of accumulated child results for a rollup finalizer.

W3C trace context captured at enqueue.

Whether the job is suspended. It stays unclaimable until resumed.

Holder of the outstanding claim. Nothing when no claim is outstanding.

The claim token.

Completed-job archive retention in seconds.

The labels and keys stamped from the payload at enqueue.

Ungrouped JobWrite with default values. For serial processing within a group, use defaultGroupedJob.

defaultJob with a group key. Jobs sharing a group key are processed serially.

Replace the payload.

Set the group key.

Set the claim priority. Lower numbers claim first. In a group, a retried job goes first.

Delay the job's first visibility.

Set the dedup key.

Set the attempt limit. Nothing takes defaultMaxAttempts. Values below minMaxAttempts are raised to it.

Attach a trace context.

Set the archive retention, in seconds.

Transform a job's payload without changing its stored metadata.

Default attempt limit stamped onto jobs whose maxAttempts is unset.

Lowest attempt limit a job is stamped with. Every job gets at least one attempt.

24h in seconds, a convenience value for setArchiveFor.

A rollup finalizer is any job whose parentState snapshot is present (an empty object from its insert or spawn, the merged child results before a DLQ move).

Effective job status. Arbiter derives status from the stored fields. The status SQL in Arbiter.Core.Sql.Jobs is its source of truth.

The wire name for a status.

Strict inverse of jobStatusToText. Unknown values are rejected.

The full payload contract. JSON round-trip for JSONB storage plus the kind, rate-limit and concurrency declarations. All three default to none.

The constraint that lets the migration collect a registry's declared policies of both kinds.

Deduplication strategy, checked on INSERT via ON CONFLICT on the dedup key.

A job's W3C trace context.

A trace context from its two stored halves. An orphan tracestate is dropped.

Callbacks fired at each point of a job's lifecycle, for metrics, logging or tracing. The worker catches an exception thrown inside one and logs it at Warning.

No-op hooks. Override fields to add observability:

myHooks = defaultObservabilityHooks
  { onJobSuccess = \job startTime endTime -> do
      let duration = diffUTCTime endTime startTime
      logInfo $ "Job " <> show (primaryKey job) <> " took " <> show duration
  }

Hooks written in m, run in n through the given natural transformation. It must be a monad morphism, such as lift.

base's finally. The second action stays interruptible.

When the worker thread received the job's batch.

The worker's clock reading after the extend landed.

When the worker thread received the job's batch.

For a success, when the ack committed. For a failure, when the handler failed the job.

A failure message.

How long to wait before the next attempt.

Internal representation shared by writable and stored jobs.

The writable columns resolved from a payload at enqueue. The kind, key and prefix columns round-trip via PayloadKeys. cost is write-only.

The dedup_key and dedup_strategy column values for a DedupKey.