Expand description
Participant message discriminants, schemas, and deterministic wire codec.
Structs§
- AckCommitted
- Continuous acknowledgement advanced the cursor.
- AckGap
- Continuous acknowledgement crossed a gap.
- AckRegression
- Continuous acknowledgement regressed below the cursor.
- Attach
Attempt Token - Single-purpose credential-attach attempt token.
- Attach
Bound - Canonical successful credential-attach receipt.
- Attach
Envelope - Credential-attach response common envelope; the secret is deliberately absent.
- Attach
Marker Proof - Attach marker-proof request fields; attach token is part of the replacement schema.
- Attach
Secret - Participant attach secret.
- Binding
Epoch - Immutable participant binding epoch.
- Closure
Capacity Reason - Capacity-specific closure refusal suffix.
- Closure
Snapshot - Unchanged-prestate suffix shared by every closure refusal scope.
- Connection
Incarnation - Server and connection identity for one accepted connection incarnation.
- Conversation
Order Exhausted - Exhausted conversation transaction order.
- Conversation
Sequence Exhausted - Canonical sequence-exhaustion response.
- Credential
Attach Request - Credential-bearing attach request body (
0x0002). - Credential
Attach Response - Server response bound to one credential-attach request.
- Detach
Attempt Token - Single-purpose explicit-detach attempt token.
- Detach
Committed - Stable committed detach response.
- Detach
Envelope - Detach response common envelope.
- Detach
InProgress - Different detach token encountered an existing pending cell.
- Detach
Request - Explicit detach request body (
0x0003). - Detach
Response - Server response bound to one explicit detach request.
- Enroll
Bound - Canonical successful enrollment receipt.
- Enrollment
Envelope - Enrollment response common envelope.
- Enrollment
Known - Enrollment token maps to a known live participant.
- Enrollment
Request - Enrollment request body (
0x0001). - Enrollment
Response - Server response bound to one enrollment request.
- Enrollment
Token - Single-purpose enrollment attempt token.
- Generation
- Nonzero participant capability or retired generation.
- Identity
Capacity Exceeded - Enrollment identity-capacity refusal.
- Inbound
Gate Context - Complete connection context needed by the inbound participant gate.
- Leave
Attempt Token - Single-purpose terminal Leave attempt token.
- Leave
Committed - Permanent terminal Leave result.
- Leave
Envelope - Leave response common envelope; the secret is deliberately absent.
- Leave
Request - Terminal participant Leave body (
0x0005). - Leave
Response - Server response bound to one terminal Leave request.
- Marker
Ack - Explicit marker acknowledgement body (
0x0006). - Marker
AckCommitted - Marker acknowledgement advanced the cursor.
- Marker
AckEnvelope - Marker-ack response common envelope.
- Marker
AckProof - Marker-ack proof request fields.
- Marker
AckResponse - Server response bound to one explicit marker acknowledgement.
- Marker
Closure Capacity Exceeded - Complete marker-closure capacity outcome payload.
- Marker
Mismatch - Presented marker does not match current marker state.
- Marker
NotDelivered - Requested marker was not delivered to the proof epoch.
- Negotiated
Participant Capability - Stored negotiated participant capability.
- NoBinding
- Missing required binding outcome.
- Observer
Backpressure State - Common observer-backpressure suffix.
- Observer
Progress Status - One observer progress status returned in request order.
- Observer
Recovery Accepted - Whole-batch observer recovery success.
- Observer
Recovery Handshake - One-shot observer-recovery batch body (
0x0008). - Observer
Recovery Response - Server response bound to one observer-recovery handshake batch.
- Observer
Refusal - One observer refusal supplied during reconnect recovery.
- Participant
Ack - Continuous cumulative acknowledgement body (
0x0004). - Participant
AckEnvelope - Continuous-ack response common envelope.
- Participant
AckResponse - Server response bound to one continuous cumulative acknowledgement.
- Participant
Cursor Progress Edge - Participant-cursor-progress edge payload on the wire.
- Participant
Delivery - Complete participant delivery push body (
0x0201). - Participant
Transport Rejected - Exact pre-semantic participant transport rejection.
- Participant
Unknown - Unknown participant outcome.
- Protocol
Version - Participant protocol version carried in every inner frame prefix.
- Record
Admission - Ordinary record-admission body (
0x0007). - Record
Admission Attempt Token - Single-purpose ordinary record-admission attempt token.
- Record
Admission Envelope - Ordinary-admission response common envelope; payload is deliberately absent.
- Record
Admission Response - Server response bound to one ordinary record admission.
- Record
Committed - Ordinary record commit result.
- Record
TooLarge - Ordinary record exceeds configured entry or byte maximum.
- Sequence
Budget - Canonical ten-field conversation sequence budget.
- Stale
OrUnknown Receipt - Attach receipt is no longer known after provenance expiry.
- TagError
- An unassigned value in a closed participant registry.
- Terminalized
Detach Cell - Data retained by the mandated terminalized detach cell.
- Validated
Frame Limit - Complete-frame allocation limit proven valid for the participant gate.
Enums§
- AckGap
Reason - Singleton normal-ack gap reason.
- AckNoOp
- Idempotent normal or marker acknowledgement.
- AckRegression
Reason - Singleton normal-ack regression reason.
- Attempt
Conflict - Ordered attempt-token conflict class.
- Attempt
Operation - Operation selector inside an attempt-token body conflict.
- Attempt
Token Body Conflict - Credential-attach or Leave token was reused with a different canonical body.
- Authentication
State - Connection authentication state presented to the inbound participant gate.
- Binding
Required Envelope - Binding-required request envelopes.
- Binding
State Tag - Binding view selector inside terminalized-detach stale authority.
- Binding
State View - Current binding view carried only by terminalized-detach authority.
- Client
Discriminant - Client-to-server participant request registry.
- Client
Request - Exhaustive client-to-server participant request.
- Close
Cause - Exact close cause; only unclean restart carries a suffix field.
- Close
Cause Tag - Binding close-cause tag registry.
- Closure
Checked Envelope - Exact common envelope alternatives for closure-checked operations.
- Closure
Refusal Reason - Exact closure refusal tagged body; no optional capacity field bag exists.
- Closure
Scope - Marker-closure refusal scope.
- Codec
Error - Deterministic participant codec failure.
- Common
Stale Authority Envelope - Common-envelope live stale-authority alternatives.
- Connection
Conversation Binding Occupied - Exact binding-slot occupancy response; occupying identity is never disclosed.
- Connection
Conversation Capacity Exceeded - Connection-conversation capacity refusal shared by two exact wire routes.
- Counter
- Counter selector used by conversation-order exhaustion.
- Decode
Class - Exhaustive participant structural decode classes.
- Detach
Authority State Tag - Detach-specific outer authority-state selector.
- Detach
Stale Authority - Detach-specific stale-authority tagged union.
- Detached
Cause - Causes valid only for a
Detachedlifecycle record. - Died
Cause - Causes valid only for a
Diedlifecycle record. - Enrollment
Receipt Capacity Scope - Receipt/provenance scopes reachable from enrollment.
- Identity
Capacity Scope - Participant identity-capacity scope.
- Inbound
Gate Error - Result category for failures before or during the participant inbound gate.
- Invalid
Observer Epoch - Whole-batch invalid observer epoch.
- Invalid
Observer Epoch List - Whole-batch invalid observer recovery list.
- Invalid
Observer Epoch List Reason - Invalid observer-recovery list reason.
- Invalid
Observer Epoch Reason - Invalid observer-epoch reason.
- Leave
Authority State Tag - Leave-specific outer authority-state selector.
- Leave
Stale Authority - Leave-specific stale-authority tagged union.
- Marker
Mismatch Body - Exact marker-mismatch reason body; no optional field bag exists.
- Marker
Mismatch Reason - Marker mismatch reason registry.
- Marker
NotDelivered Reason - Singleton marker-not-delivered reason registry.
- Marker
Proof Request - Marker-proof request alternatives.
- Observer
Backpressure - Exact operation-specific observer-backpressure payload.
- Order
Allocating Envelope - Request kinds that may require an unreserved transaction-order major.
- Participant
Capability State - Participant-capability state presented to the inbound gate.
- Participant
Frame - One complete typed participant frame.
- Participant
Record - Exact record-kind body carried by
ParticipantDelivery. - Participant
Reference Envelope - Participant-naming envelopes eligible for unknown/retired classification.
- Push
Discriminant - Server-pushed participant control/value registry.
- Receipt
Capacity Exceeded - Receipt/provenance capacity refusal with origin-specific valid scopes.
- Receipt
Capacity Scope - Receipt/provenance capacity scope.
- Receipt
Expired - Exact expired/superseded receipt response.
- Receipt
Expiry Reason - Receipt-expiry reason.
- Receipt
Replay - Complete canonical receipt replay payload used by Bound/UnboundReceipt.
- Receiver
Direction - Receiver whose direction registry is used during decoding.
- Record
Kind - Participant delivery record-kind registry.
- Repayment
Edge - Clear state or one of the seven stored repayment edges.
- Repayment
Edge Tag - Stored repayment-edge tag, including the clear state.
- Resource
Dimension Tag - Entry-before-bytes resource dimension registry.
- Response
Envelope - Exact operation-specific response envelope for requests
0x0001..=0x0007. - Retired
- Tombstone classification, including enrollment’s additional participant id.
- Sequence
Allocating Envelope - Request alternatives that can exhaust optional sequence admission.
- Server
Discriminant - Server-to-client semantic participant value registry.
- Server
Push - Exhaustive pushed participant control/value.
- Server
Value - Exhaustive server-to-client semantic participant value.
- Stale
Authority - Complete stale-authority outcome payload.
- Transport
Reason Tag - Transport rejection union tag.
- Transport
Rejection Reason - Closed transport-rejection reason union.
Constants§
- FRAME_
MAX - Largest complete frame representable by the generic
u32payload length. - GENERIC_
HEADER_ LEN - Bytes in the existing generic frame header.
- MIN_
PARTICIPANT_ FRAME_ MAX - Smallest valid complete participant-frame allocation limit.
- PARTICIPANT_
CAPABILITY - Exact capability string serialized by transport capability refusal.
- PARTICIPANT_
FRAME_ OVERHEAD - Fixed complete-frame overhead before a selected participant body.
- PARTICIPANT_
FRAME_ TYPE - Stable generic frame type assigned to participant traffic.
- PARTICIPANT_
PREFIX_ LEN - Bytes in the version/discriminant prefix of every participant payload.
- PRECAP_
PARTICIPANT_ FRAME_ MAX - Allocation ceiling used before participant capability is stored.
Functions§
- attempt_
operation - Returns the exact attempt operation implied by a body-conflict variant.
- capability_
string - Owns a capability string after wire decoding while retaining domain validation.
- complete_
frame_ bytes - Computes complete bytes from a generic-header payload length.
- decode
- Decodes one exact complete participant frame for
receiver. - decode_
server_ value_ body - Decodes one exact semantic server-value body under v1.0.
- encode
- Encodes one complete participant frame into caller-provided storage.
- encode_
server_ value_ body - Encodes a semantic server value’s exact v1 body.
- encoded_
len - Returns the exact complete-frame encoded length.
- gate_
inbound - Applies the total R-D2 inbound gate to one declared complete frame.
Type Aliases§
- Authority
State Tag - Compatibility name for the detach authority-state registry.
- Conversation
Id - Stable conversation identifier.
- Delivery
Seq - Conversation delivery sequence.
- Observer
Epoch - Observer refusal/progress epoch.
- Participant
Id - Permanent participant identifier and base identity index.
- Participant
Index - Permanent participant index used by participant-scoped progress accounting.
- Transaction
Order - Serialized conversation transaction order.