Skip to main content

Module envelope

Module envelope 

Source
Expand description

Stream boundary contract: the StreamEnvelope that wraps every packet crossing the streaming fabric.

An envelope binds a StreamPacket to the routing and timing metadata a transport needs to carry it: the originating stream and packet ids, the media and direction, a monotonic sequence number, the Ticks that locate it on its clocks, the ClockDomains it rides, the TransportProfile that bounds what the transport may do, and any diagnostics raised along the way.

The kernel owns the protocol vocabulary referenced here – Symbol, Expr, Tick, and the clock/capability contracts. This module supplies the concrete envelope behavior: construction with validation, the wire form (StreamEnvelope::to_expr / TryFrom<Expr>), and the mapping of clock-domain symbols to the ClockDomain enum.

Structs§

StreamEnvelope
A single packet plus the routing and timing metadata that carries it across the streaming fabric.
TransportProfile
The capability and latency contract a transport offers for a stream.

Enums§

ClockDomain
Clock a stream is timed against.
LatencyClass
Real-time latency promise a transport profile makes.
StreamCapability
One thing a transport is permitted to do with a stream.

Constants§

STREAM_ENVELOPE_VERSION
Wire version of the StreamEnvelope map form.

Functions§

stream_envelope_tag_symbol
Returns the runtime tag Symbol that marks a map as a stream envelope.