Skip to main content

Module wire

Module wire 

Source
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§

CheckpointRequest
One bounded byte range of a previously pinned recovery checkpoint.
CompactState
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.
ControlEncoding
Envelope and valid prefix length in the caller’s reusable metadata buffer.
EncodeContext
Local sender, established link session, and bounds of one encoded packet.
FetchOps
One bounded request into a previously advertised immutable history.
FlowProbe
One immutable status request, including the tail needed to detect a lost last batch.
FlowState
Correlated status response or coalesced same-epoch receipt notification.
HistoryRetired
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.
PeerBinding
Authenticated peer and established session supplied by the transport adapter.
Prepare
One bounded outbound prepare, borrowing prevalidated canonical operations.
PrepareBatch
Hash-validated prepare borrowing the packet’s backing buffers.
PrepareEncoding
Exact prefixes of caller-owned metadata/payload buffers for PREPARE or OPS.
PrepareMetadata
Canonical metadata encoded before a transport session or receive epoch is available. This is not a sendable packet and contains no envelope header.
RecoveryRequest
Fresh recovery attempt carried by one independently correlated link exchange.
RecoveryState
Correlated reply retaining the core’s nonce-scoped normal-state evidence.
VerifiedOperation
Decoder-verified body and envelope, borrowing the exact immutable packet bytes.
WireLimits
Directional receive and command work bounds.

Enums§

CheckpointMessage
Source-bound checkpoint exchange, supplying no normal quorum evidence.
Control
Fixed-size replica control metadata. Receipt alone has no authority.
FlowMessage
Separately typed nonvoting flow family, sharing the ordinary replica envelope.
HistoryFence
Exact old receiver or history request being withdrawn. Neither is authority.
ReceiveFence
Exact purpose of one actor-backed replica receive reservation. This is not authentication, history validation, or replication authority.
RecoveryMessage
Separate recovery family. These messages never supply normal durable votes.
ReplicaMessage
Decoded replica command, still subject to role/history checks in the core.
WireError
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_OPEN into caller-owned metadata, leaving output unchanged on error.
encode_flow_state
Encode a REPLICA_STATE response/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 RECOVERY without allocations or output mutation on error.
encode_recovery_state
Encode RECOVERY_STATE into 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 decode with an independently established PeerBinding.