# StatifierOban v0.17.3 - Table of Contents

> Durable timers and async invoke execution for Statifier, backed by Oban

## Pages

- [StatifierOban](readme.md)
- [Changelog](changelog.md)

- Upgrading
  - [Upgrading a host from 0.11 to 0.17](upgrading.md)

## Modules

- [StatifierOban](StatifierOban.md): Durable timers and async invoke execution for
[Statifier](https://github.com/riddler/statifier-ex), backed by Oban.
- [StatifierOban.Config](StatifierOban.Config.md): Configuration for running Statifier effects on a host-supplied Oban
instance.
- [StatifierOban.Invoke.ChildStartWorker](StatifierOban.Invoke.ChildStartWorker.md): The Oban worker that creates one child of a fan-out.
- [StatifierOban.Invoke.ChildStarter](StatifierOban.Invoke.ChildStarter.md): The seam a fan-out's child executions are created through.
- [StatifierOban.Invoke.Delivery](StatifierOban.Invoke.Delivery.md): The delivery seam a completed invoke goes through - the execution-liveness
check at the `done.invoke` door, the same shape
`StatifierOban.Timer.Delivery` gives a fired timer.
- [StatifierOban.Invoke.Delivery.Session](StatifierOban.Invoke.Delivery.Session.md): The default `StatifierOban.Invoke.Delivery`: reports a completed
invoke back into a live `Statifier.Session` through
`Statifier.Session.done_invocation/3`, and a permanently failed one
through `Statifier.Session.failed_invocation/3`, both behind the same
two-step liveness check `StatifierOban.Timer.Delivery.Session` runs
for a fired timer.
- [StatifierOban.Invoke.FanOut](StatifierOban.Invoke.FanOut.md): The scheduling half of a fan-out: the cap, the N start jobs, and the
cancel of the ones that have not started.
- [StatifierOban.Invoke.Handler](StatifierOban.Invoke.Handler.md): The Oban-backed base for a `Statifier.Invoke.Handler` implementation:
`use` it and the host's `<invoke type="...">` runs its work in an Oban
job on the host-supplied instance, with completion delivered back into
the execution as `done.invoke.<invoke_id>` through
`StatifierOban.Invoke.Delivery`.
- [StatifierOban.Invoke.JobArgs](StatifierOban.Invoke.JobArgs.md): The wire shape between a `%Statifier.Effect.Invoke{}` and the args map
an invoke-handler Oban job stores.
- [StatifierOban.Invoke.Worker](StatifierOban.Invoke.Worker.md): The Oban worker a base-handler invocation becomes.
- [StatifierOban.OpaqueTerm](StatifierOban.OpaqueTerm.md): Tagged `:erlang.term_to_binary/1` payloads for the host-opaque fields a
job's args carry.
- [StatifierOban.OpaqueTerm.Codec](StatifierOban.OpaqueTerm.Codec.md): A host-supplied transform over the bytes of an opaque job-arg payload.
- [StatifierOban.Telemetry](StatifierOban.Telemetry.md): The `:telemetry` surface for this package's durable seams (ADR-0006) -
the single definition site for every `[:statifier_oban, ...]` event name,
and the one module that calls `:telemetry.execute/3`.
- [StatifierOban.Timer](StatifierOban.Timer.md): Consumes `{:send_delayed, %Statifier.Effect.SendDelayed{}}` into a
uniquely-keyed job on the host's Oban instance.
- [StatifierOban.Timer.CancellationKey](StatifierOban.Timer.CancellationKey.md): `{session scope, send_id}` - the key a cancel addresses.
- [StatifierOban.Timer.DedupKey](StatifierOban.Timer.DedupKey.md): `{session scope, ordinal}` - the compact dedup key ADR-0059 decision 3
blesses, read off the stored `%Statifier.Effect.SendDelayed{}`.
- [StatifierOban.Timer.Delivery](StatifierOban.Timer.Delivery.md): The delivery seam a fired timer job goes through - the execution-liveness
check st-ADR-0054 decision 4 requires, plus the feed-back itself.
- [StatifierOban.Timer.Delivery.Session](StatifierOban.Timer.Delivery.Session.md): The default `StatifierOban.Timer.Delivery`: feeds a fired event back
into a live `Statifier.Session`, behind the two-step liveness check
statifier-ex's `docs/durable-timers.md` spells out.
- [StatifierOban.Timer.JobArgs](StatifierOban.Timer.JobArgs.md): The wire shape between a `%Statifier.Effect.SendDelayed{}` and the args
map an Oban job stores.
- [StatifierOban.Timer.Key](StatifierOban.Timer.Key.md): Derives the two scoped keys a durable-timer store needs, per ADR-0054
decision 3 as amended by ADR-0059, and `docs/durable-timers.md` ("Keying
your store") in statifier-ex.
- [StatifierOban.Timer.PinSource](StatifierOban.Timer.PinSource.md): Pending timers as a `StatifierPersistence.PinSource`, per ADR-0008.
- [StatifierOban.Timer.Worker](StatifierOban.Timer.Worker.md): The Oban worker a `%Statifier.Effect.SendDelayed{}` becomes.