Skip to main content

Module wire

Module wire 

Source
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.
AttachAttemptToken
Single-purpose credential-attach attempt token.
AttachBound
Canonical successful credential-attach receipt.
AttachEnvelope
Credential-attach response common envelope; the secret is deliberately absent.
AttachMarkerProof
Attach marker-proof request fields; attach token is part of the replacement schema.
AttachSecret
Participant attach secret.
BindingEpoch
Immutable participant binding epoch.
ClosureCapacityReason
Capacity-specific closure refusal suffix.
ClosureSnapshot
Unchanged-prestate suffix shared by every closure refusal scope.
ConnectionIncarnation
Server and connection identity for one accepted connection incarnation.
ConversationOrderExhausted
Exhausted conversation transaction order.
ConversationSequenceExhausted
Canonical sequence-exhaustion response.
CredentialAttachRequest
Credential-bearing attach request body (0x0002).
CredentialAttachResponse
Server response bound to one credential-attach request.
DetachAttemptToken
Single-purpose explicit-detach attempt token.
DetachCommitted
Stable committed detach response.
DetachEnvelope
Detach response common envelope.
DetachInProgress
Different detach token encountered an existing pending cell.
DetachRequest
Explicit detach request body (0x0003).
DetachResponse
Server response bound to one explicit detach request.
EnrollBound
Canonical successful enrollment receipt.
EnrollmentEnvelope
Enrollment response common envelope.
EnrollmentKnown
Enrollment token maps to a known live participant.
EnrollmentRequest
Enrollment request body (0x0001).
EnrollmentResponse
Server response bound to one enrollment request.
EnrollmentToken
Single-purpose enrollment attempt token.
Generation
Nonzero participant capability or retired generation.
IdentityCapacityExceeded
Enrollment identity-capacity refusal.
InboundGateContext
Complete connection context needed by the inbound participant gate.
LeaveAttemptToken
Single-purpose terminal Leave attempt token.
LeaveCommitted
Permanent terminal Leave result.
LeaveEnvelope
Leave response common envelope; the secret is deliberately absent.
LeaveRequest
Terminal participant Leave body (0x0005).
LeaveResponse
Server response bound to one terminal Leave request.
MarkerAck
Explicit marker acknowledgement body (0x0006).
MarkerAckCommitted
Marker acknowledgement advanced the cursor.
MarkerAckEnvelope
Marker-ack response common envelope.
MarkerAckProof
Marker-ack proof request fields.
MarkerAckResponse
Server response bound to one explicit marker acknowledgement.
MarkerClosureCapacityExceeded
Complete marker-closure capacity outcome payload.
MarkerMismatch
Presented marker does not match current marker state.
MarkerNotDelivered
Requested marker was not delivered to the proof epoch.
NegotiatedParticipantCapability
Stored negotiated participant capability.
NoBinding
Missing required binding outcome.
ObserverBackpressureState
Common observer-backpressure suffix.
ObserverProgressStatus
One observer progress status returned in request order.
ObserverRecoveryAccepted
Whole-batch observer recovery success.
ObserverRecoveryHandshake
One-shot observer-recovery batch body (0x0008).
ObserverRecoveryResponse
Server response bound to one observer-recovery handshake batch.
ObserverRefusal
One observer refusal supplied during reconnect recovery.
ParticipantAck
Continuous cumulative acknowledgement body (0x0004).
ParticipantAckEnvelope
Continuous-ack response common envelope.
ParticipantAckResponse
Server response bound to one continuous cumulative acknowledgement.
ParticipantCursorProgressEdge
Participant-cursor-progress edge payload on the wire.
ParticipantDelivery
Complete participant delivery push body (0x0201).
ParticipantTransportRejected
Exact pre-semantic participant transport rejection.
ParticipantUnknown
Unknown participant outcome.
ProtocolVersion
Participant protocol version carried in every inner frame prefix.
RecordAdmission
Ordinary record-admission body (0x0007).
RecordAdmissionAttemptToken
Single-purpose ordinary record-admission attempt token.
RecordAdmissionEnvelope
Ordinary-admission response common envelope; payload is deliberately absent.
RecordAdmissionResponse
Server response bound to one ordinary record admission.
RecordCommitted
Ordinary record commit result.
RecordTooLarge
Ordinary record exceeds configured entry or byte maximum.
SequenceBudget
Canonical ten-field conversation sequence budget.
StaleOrUnknownReceipt
Attach receipt is no longer known after provenance expiry.
TagError
An unassigned value in a closed participant registry.
TerminalizedDetachCell
Data retained by the mandated terminalized detach cell.
ValidatedFrameLimit
Complete-frame allocation limit proven valid for the participant gate.

Enums§

AckGapReason
Singleton normal-ack gap reason.
AckNoOp
Idempotent normal or marker acknowledgement.
AckRegressionReason
Singleton normal-ack regression reason.
AttemptConflict
Ordered attempt-token conflict class.
AttemptOperation
Operation selector inside an attempt-token body conflict.
AttemptTokenBodyConflict
Credential-attach or Leave token was reused with a different canonical body.
AuthenticationState
Connection authentication state presented to the inbound participant gate.
BindingRequiredEnvelope
Binding-required request envelopes.
BindingStateTag
Binding view selector inside terminalized-detach stale authority.
BindingStateView
Current binding view carried only by terminalized-detach authority.
ClientDiscriminant
Client-to-server participant request registry.
ClientRequest
Exhaustive client-to-server participant request.
CloseCause
Exact close cause; only unclean restart carries a suffix field.
CloseCauseTag
Binding close-cause tag registry.
ClosureCheckedEnvelope
Exact common envelope alternatives for closure-checked operations.
ClosureRefusalReason
Exact closure refusal tagged body; no optional capacity field bag exists.
ClosureScope
Marker-closure refusal scope.
CodecError
Deterministic participant codec failure.
CommonStaleAuthorityEnvelope
Common-envelope live stale-authority alternatives.
ConnectionConversationBindingOccupied
Exact binding-slot occupancy response; occupying identity is never disclosed.
ConnectionConversationCapacityExceeded
Connection-conversation capacity refusal shared by two exact wire routes.
Counter
Counter selector used by conversation-order exhaustion.
DecodeClass
Exhaustive participant structural decode classes.
DetachAuthorityStateTag
Detach-specific outer authority-state selector.
DetachStaleAuthority
Detach-specific stale-authority tagged union.
DetachedCause
Causes valid only for a Detached lifecycle record.
DiedCause
Causes valid only for a Died lifecycle record.
EnrollmentReceiptCapacityScope
Receipt/provenance scopes reachable from enrollment.
IdentityCapacityScope
Participant identity-capacity scope.
InboundGateError
Result category for failures before or during the participant inbound gate.
InvalidObserverEpoch
Whole-batch invalid observer epoch.
InvalidObserverEpochList
Whole-batch invalid observer recovery list.
InvalidObserverEpochListReason
Invalid observer-recovery list reason.
InvalidObserverEpochReason
Invalid observer-epoch reason.
LeaveAuthorityStateTag
Leave-specific outer authority-state selector.
LeaveStaleAuthority
Leave-specific stale-authority tagged union.
MarkerMismatchBody
Exact marker-mismatch reason body; no optional field bag exists.
MarkerMismatchReason
Marker mismatch reason registry.
MarkerNotDeliveredReason
Singleton marker-not-delivered reason registry.
MarkerProofRequest
Marker-proof request alternatives.
ObserverBackpressure
Exact operation-specific observer-backpressure payload.
OrderAllocatingEnvelope
Request kinds that may require an unreserved transaction-order major.
ParticipantCapabilityState
Participant-capability state presented to the inbound gate.
ParticipantFrame
One complete typed participant frame.
ParticipantRecord
Exact record-kind body carried by ParticipantDelivery.
ParticipantReferenceEnvelope
Participant-naming envelopes eligible for unknown/retired classification.
PushDiscriminant
Server-pushed participant control/value registry.
ReceiptCapacityExceeded
Receipt/provenance capacity refusal with origin-specific valid scopes.
ReceiptCapacityScope
Receipt/provenance capacity scope.
ReceiptExpired
Exact expired/superseded receipt response.
ReceiptExpiryReason
Receipt-expiry reason.
ReceiptReplay
Complete canonical receipt replay payload used by Bound/UnboundReceipt.
ReceiverDirection
Receiver whose direction registry is used during decoding.
RecordKind
Participant delivery record-kind registry.
RepaymentEdge
Clear state or one of the seven stored repayment edges.
RepaymentEdgeTag
Stored repayment-edge tag, including the clear state.
ResourceDimensionTag
Entry-before-bytes resource dimension registry.
ResponseEnvelope
Exact operation-specific response envelope for requests 0x0001..=0x0007.
Retired
Tombstone classification, including enrollment’s additional participant id.
SequenceAllocatingEnvelope
Request alternatives that can exhaust optional sequence admission.
ServerDiscriminant
Server-to-client semantic participant value registry.
ServerPush
Exhaustive pushed participant control/value.
ServerValue
Exhaustive server-to-client semantic participant value.
StaleAuthority
Complete stale-authority outcome payload.
TransportReasonTag
Transport rejection union tag.
TransportRejectionReason
Closed transport-rejection reason union.

Constants§

FRAME_MAX
Largest complete frame representable by the generic u32 payload 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§

AuthorityStateTag
Compatibility name for the detach authority-state registry.
ConversationId
Stable conversation identifier.
DeliverySeq
Conversation delivery sequence.
ObserverEpoch
Observer refusal/progress epoch.
ParticipantId
Permanent participant identifier and base identity index.
ParticipantIndex
Permanent participant index used by participant-scoped progress accounting.
TransactionOrder
Serialized conversation transaction order.