# wardrik_events v0.1.0-rc.1 - API Reference

## Modules

- [WardrikEvents](WardrikEvents.md): Keeps each agent's events as CloudEvents, in a log you can read back and follow.
- [WardrikEvents.Activity](WardrikEvents.Activity.md): A view of what an agent is doing now, as the protocol's `activity`.
- [WardrikEvents.Audit](WardrikEvents.Audit.md): Keeps the audit: one log for the deployment of what people changed and who changed it.
- [WardrikEvents.CloudEvent](WardrikEvents.CloudEvent.md): Builds events as Wardrik sends them: CloudEvents maps with string keys and the payload under
`"data"`.

- [WardrikEvents.Cursor](WardrikEvents.Cursor.md): Encodes and decodes cursors. A cursor is the last sequence number read in each log.
- [WardrikEvents.Encoder](WardrikEvents.Encoder.md): Encodes an agent's `WardrikCore.Event`s as the CloudEvents of `WardrikProtocol`.

- [WardrikEvents.Encoder.Value](WardrikEvents.Encoder.Value.md): Encodes the values inside an event's data as JSON-ready maps with string keys.

- [WardrikEvents.Heads](WardrikEvents.Heads.md): Holds the events' settings, each log's last sequence number and each agent's activity in an ETS
table.

- [WardrikEvents.Listener](WardrikEvents.Listener.md): Follows agents' events into your app.
- [WardrikEvents.Log](WardrikEvents.Log.md): Reads and writes one log: an agent's kept events in a store, in order, each under its sequence
number.
- [WardrikEvents.Pattern](WardrikEvents.Pattern.md): Matches log names against patterns. `*` matches any run of characters, and `?` matches one.
- [WardrikEvents.Reader](WardrikEvents.Reader.md): Reads kept events back from the logs patterns match.
- [WardrikEvents.Retention](WardrikEvents.Retention.md): Drops events older than `:retention` days, once an hour. See `WardrikEvents.start_link/1`.
- [WardrikEvents.Runs](WardrikEvents.Runs.md): A view of an agent's runs, and the totals across them.
- [WardrikEvents.Subscribers](WardrikEvents.Subscribers.md): Sends each event, as it's written, to the processes subscribed to its log.
- [WardrikEvents.Tail](WardrikEvents.Tail.md): Reads logs back from a cursor, then follows them as they're written.
- [WardrikEvents.Timeline](WardrikEvents.Timeline.md): A view of an agent's conversation: each message people sent, and each run that answered, step
by step.
- [WardrikEvents.View](WardrikEvents.View.md): The behaviour for views. A view folds an agent's events, oldest first, into what a screen shows.