# viewstamped_replication v3.0.4 - Table of Contents

> A protocol-generic Viewstamped Replication runtime for Elixir

## Pages

- [Viewstamped Replication](readme.md)
- [LICENSE](license.md)

## Modules

- [ViewstampedReplication](ViewstampedReplication.md): Protocol-generic Viewstamped Replication runtime.

- [ViewstampedReplication.ApplyMetadata](ViewstampedReplication.ApplyMetadata.md): Protocol metadata supplied to the deterministic state machine.

- [ViewstampedReplication.Client](ViewstampedReplication.Client.md): Stateful VSR client session with monotonic request numbers and retries.
- [ViewstampedReplication.Configuration](ViewstampedReplication.Configuration.md): An explicit, ordered, fixed-membership VSR configuration.
- [ViewstampedReplication.Log](ViewstampedReplication.Log.md): An immutable, contiguous VSR operation log.

- [ViewstampedReplication.LogEntry](ViewstampedReplication.LogEntry.md): A client operation at a stable position in the replicated log.

- [ViewstampedReplication.Member](ViewstampedReplication.Member.md): A replica in an ordered VSR configuration.

- [ViewstampedReplication.Protocol](ViewstampedReplication.Protocol.md): Pure Viewstamped Replication state transition kernel.
- [ViewstampedReplication.Protocol.Effect](ViewstampedReplication.Protocol.Effect.md): Ordered effects emitted by the pure protocol core.
- [ViewstampedReplication.Protocol.Envelope](ViewstampedReplication.Protocol.Envelope.md): Versioned, group-scoped protocol message envelope.
- [ViewstampedReplication.Protocol.Event](ViewstampedReplication.Protocol.Event.md): Events accepted by the pure protocol transition function.
- [ViewstampedReplication.Protocol.State](ViewstampedReplication.Protocol.State.md): Immutable state consumed and returned by the pure VSR protocol.

- [ViewstampedReplication.Replica](ViewstampedReplication.Replica.md): Supervised effect interpreter for one VSR replica.
- [ViewstampedReplication.Reply](ViewstampedReplication.Reply.md): The cached result of an applied client request.

- [ViewstampedReplication.Request](ViewstampedReplication.Request.md): A client operation with a stable client identity and monotonic request number.

- [ViewstampedReplication.StateMachine](ViewstampedReplication.StateMachine.md): Contract for a deterministic service replicated by VSR.
- [ViewstampedReplication.Storage](ViewstampedReplication.Storage.md): Durable-state adapter contract used by a replica runtime.
- [ViewstampedReplication.Storage.File](ViewstampedReplication.Storage.File.md): Checksummed write-ahead log and atomic checkpoint storage.
- [ViewstampedReplication.Storage.Memory](ViewstampedReplication.Storage.Memory.md): Volatile storage for protocol development and deterministic tests.

- [ViewstampedReplication.Telemetry](ViewstampedReplication.Telemetry.md): Thin, optional-to-observe telemetry boundary for the runtime.

- [ViewstampedReplication.Transport](ViewstampedReplication.Transport.md): Message delivery boundary for protocol envelopes.
- [ViewstampedReplication.Transport.Distribution](ViewstampedReplication.Transport.Distribution.md): Explicit distributed-Erlang endpoint delivery.
- [ViewstampedReplication.Transport.Local](ViewstampedReplication.Transport.Local.md): Deterministic same-VM delivery through the VSR registry.