Struct Frame 

pub struct Frame {
    pub reliability: Reliability,
    pub sn: TransportSn,
    pub ext_qos: QoSType,
    pub payload: Vec<NetworkMessage>,
}

Frame message

The Frame message is used to transmit one ore more complete serialized NetworkMessage. I.e., the total length of the serialized NetworkMessage (s) MUST be smaller than the maximum batch size (i.e. 2^16-1) and the link MTU. The Frame message is used as means to aggregate multiple NetworkMessage in a single atomic message that goes on the wire. By doing so, many small messages can be batched together and share common information like the sequence number.

The Frame message flow is the following:

    A                   B
    |      FRAME        |
    |------------------>|
    |                   |

The Frame message structure is defined as follows:

Flags:
- R: Reliable       If R==1 it concerns the reliable channel, else the best-effort channel
- X: Reserved
- Z: Extensions     If Z==1 then zenoh extensions will follow.

 7 6 5 4 3 2 1 0
+-+-+-+-+-+-+-+-+
|Z|X|R|  FRAME  |
+-+-+-+---------+
%    seq num    %
+---------------+
~  [FrameExts]  ~ if Flag(Z)==1
+---------------+
~  [NetworkMsg] ~
+---------------+

NOTE: 16 bits (2 bytes) may be prepended to the serialized message indicating the total length in bytes of the message, resulting in the maximum length of a message being 65535 bytes. This is necessary in those stream-oriented transports (e.g., TCP) that do not preserve the boundary of the serialized messages. The length is encoded as little-endian. In any case, the length of a message must not exceed 65535 bytes.

Fields

reliability: Reliability

sn: TransportSn

ext_qos: QoSType

payload: Vec<NetworkMessage>

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Frame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Frame> for TransportMessage

fn from(frame: Frame) -> Self

Converts to this type from the input type.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Frame

impl StructuralPartialEq for Frame