Expand description
Bounded native replica messages. No I/O or implicit consensus authority.
The transport supplies an independently authenticated voter/session binding. Scope decoding checks the immutable configuration; the production cores still decide whether the message’s view, history, role, and evidence are admissible.
Structs§
- Checkpoint
Request - One bounded byte range of a previously pinned recovery checkpoint.
- Compact
State - An authenticated channel handle plus cumulative receive counters. Handles bind peer, link session, configuration, view, receive epoch and base at full channel opening. They must never be recycled within a link session.
- Control
Encoding - Envelope and valid prefix length in the caller’s reusable metadata buffer.
- Encode
Context - Local sender, established link session, and bounds of one encoded packet.
- Fetch
Ops - One bounded request into a previously advertised immutable history.
- Flow
Probe - One immutable status request, including the tail needed to detect a lost last batch.
- Flow
State - Correlated status response or coalesced same-epoch receipt notification.
- History
Retired - Primary hint to withdraw a lagging receiver before fresh quorum recovery. This carries no vote, commit proof, or checkpoint installation authority.
- Operation
- Immutable canonical bytes and their already computed body/envelope digests.
- Operations
- Allocation-free iteration over an already checked operation batch.
- OpsBatch
- Borrowed, hash-validated response from one frozen source generation.
- Peer
Binding - Authenticated peer and established session supplied by the transport adapter.
- Prepare
- One bounded outbound prepare, borrowing prevalidated canonical operations.
- Prepare
Batch - Hash-validated prepare borrowing the packet’s backing buffers.
- Prepare
Encoding - Exact prefixes of caller-owned metadata/payload buffers for PREPARE or OPS.
- Prepare
Metadata - Canonical metadata encoded before a transport session or receive epoch is available. This is not a sendable packet and contains no envelope header.
- Recovery
Request - Fresh recovery attempt carried by one independently correlated link exchange.
- Recovery
State - Correlated reply retaining the core’s nonce-scoped normal-state evidence.
- Verified
Operation - Decoder-verified body and envelope, borrowing the exact immutable packet bytes.
- Wire
Limits - Directional receive and command work bounds.
Enums§
- Checkpoint
Message - Source-bound checkpoint exchange, supplying no normal quorum evidence.
- Control
- Fixed-size replica control metadata. Receipt alone has no authority.
- Flow
Message - Separately typed nonvoting flow family, sharing the ordinary replica envelope.
- History
Fence - Exact old receiver or history request being withdrawn. Neither is authority.
- Receive
Fence - Exact purpose of one actor-backed replica receive reservation. This is not authentication, history validation, or replication authority.
- Recovery
Message - Separate recovery family. These messages never supply normal durable votes.
- Replica
Message - Decoded replica command, still subject to role/history checks in the core.
- Wire
Error - Structural wire failure. No rejection changes replica or journal state.
Constants§
- COMPACT_
STATE_ BYTES - One single-part message, small enough for OMQ’s routed inline storage.
- PUBLICATION_
BYTES - Publication prefix size; no recipient masks or per-follower credit fields.
- PUBLICATION_
TOPIC_ BYTES - One group ID is the complete subscription prefix.
Functions§
- decode
- Decode a bounded packet and reject mismatched voter/session/configuration.
- decode_
publication - Decode only from a separately bound publisher socket. Reject wrong leader, scope or group before hashing any payload. PUB receipt is neither admission nor a vote; ordinary receive and core checks still apply.
- encode_
checkpoint - Encode checkpoint request/chunk metadata without copying state bytes.
- encode_
control - Encode control metadata into caller-owned storage without allocating.
- encode_
fetch - Encode a correlated request without allocating or modifying output on error.
- encode_
flow_ prepare - Encode epoch-bound normal data with a mandatory receiver-issued epoch.
- encode_
flow_ prepare_ metadata - Encode only the header and metadata of a credited
PREPARE_FLOW. - encode_
flow_ probe - Encode
REPLICA_OPENinto caller-owned metadata, leaving output unchanged on error. - encode_
flow_ state - Encode a
REPLICA_STATEresponse/notification without allocating or granting authority. Local retention bounds are independent of the maximum size of one wire frame. - encode_
history_ retired - Encode a receiver-fenced withdrawal hint on the control plane.
- encode_
ops - Encode complete canonical operations from the exact pinned request source.
- encode_
prepare - Encode into reusable caller-owned buffers, preserving them on rejection.
- encode_
prepare_ metadata - Encode only PREPARE framing. Pair with the identical canonical body backing.
- encode_
prepare_ unbound - Encode bounded canonical descriptors without inventing a link session. Bind a real session, receive epoch, and current commit before transmission. Invalid fields or capacity leave the output unchanged, as for wire encoding.
- encode_
publication - Reframe an actor-owned PREPARE template without copying or hashing its body. The caller retains the original, already validated payload for publication.
- encode_
recovery - Encode full-WAL
RECOVERYwithout allocations or output mutation on error. - encode_
recovery_ state - Encode
RECOVERY_STATEinto reusable storage without mutation on error. - flow_
state_ route - Structural full report decoding for bounded compact routing registration. This supplies no membership, receive credit, or replication authority.
- publication_
topic - Common topic for every follower of this group.
- route
- Read only the fixed group/configuration prefix of an implemented PEER
command. This does not authenticate the sender or validate membership, view,
operation hashes, or payloads. Dispatch uses it to select an actor, which must
still call
decodewith an independently establishedPeerBinding.