Raxol.Journal (Raxol Journal v2.8.0)

Copy Markdown View Source

Raxol.Journal.* names for the modules of this package.

Every function here delegates to the Raxol.Agent.Journal.* or Raxol.Agent.Contract module of the same shape:

AliasModule
Raxol.JournalRaxol.Agent.Journal
Raxol.Journal.FileStoreRaxol.Agent.Journal.FileStore
Raxol.Journal.FileStore.ReaderRaxol.Agent.Journal.FileStore.Reader
Raxol.Journal.FileStore.WriterRaxol.Agent.Journal.FileStore.Writer
Raxol.Journal.ChainRaxol.Agent.Journal.Chain
Raxol.Journal.TipRaxol.Agent.Journal.Tip
Raxol.Journal.Records.CheckpointRaxol.Agent.Journal.Records.Checkpoint
Raxol.Journal.Records.Checkpoint.FileBackendRaxol.Agent.Journal.Records.Checkpoint.FileBackend
Raxol.Journal.ContractRaxol.Agent.Contract
Raxol.Journal.Contract.EventRaxol.Agent.Contract.Event

An alias carries functions and types only. The structs (%Raxol.Agent.Journal.FileStore{}, %Raxol.Agent.Contract.Event{}), the behaviours (Raxol.Agent.Journal, Raxol.Agent.Journal.Records.Checkpoint) and the process and :persistent_term names keep their Raxol.Agent.* names.

Raxol.Journal.Test.* are not aliases: they are helpers for ExUnit suites.

Summary

Types

event()

@type event() :: Raxol.Agent.Journal.event()

handle()

@type handle() :: Raxol.Agent.Journal.handle()

journal_record()

@type journal_record() :: Raxol.Agent.Journal.journal_record()

offset()

@type offset() :: Raxol.Agent.Journal.offset()

session_id()

@type session_id() :: Raxol.Agent.Journal.session_id()

Functions

verify(handle)

See Raxol.Agent.Journal.verify/1.