API Reference Outbox v#0.1.0-beta.1

Copy Markdown View Source

Modules

Public facade for the Outbox transactional event bus.

Outbox's root supervisor.

Read-only accessors for Outbox's application configuration.

Polls the outbox_events table for undispatched events and fans them out to subscribers.

Ecto schema for the outbox_events table.

Deletes old, dispatched outbox events.

Resolves event names to subscriber modules.

Behaviour for modules that react to domain events from the bus.

Oban worker that runs a single subscriber's handle_event/3 for one outbox event.

Test helpers for asserting domain-event publication and exercising subscribers synchronously.

Periodically runs Outbox.Dispatcher.run/0 in a supervised Task.

Mix Tasks

Generates the outbox_events table migration in the host's priv/repo/migrations/ directory.