msrt 0.1.4

Portable MSRT protocol implementation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Integration tests for the no_std MSRT protocol facade.

const TX_BUF_BYTES: usize = 128;

use msrt::{
    Engine,
    core::{ChannelId, Flags, MessageId, Packet, PacketHeader, PacketIndex},
    engine::EnginePoll,
    reliability::{
        ChannelReliability, FragmentRange, MessageFragment, MessageKey, ReliabilityMode,
    },
    wire::{EnvelopeHeader, EnvelopeMagic, WireEnvelope},
};

#[test]
fn facade_exposes_core_packet_and_wire_envelope() {
    let payload = [0x01, 0x02, 0x03];
    let header = PacketHeader::data(
        PacketIndex::new(0),
        Flags::ACK_ELICITING,
        ChannelId::DEFAULT,
        MessageId::new(7),
        payload.len(),
        0,
    );
    let packet = Packet::new(header, &payload);

    let envelope_header = EnvelopeHeader::new(packet.payload_len() as u8);
    let envelope = WireEnvelope::new(envelope_header, packet.payload.as_bytes());

    assert_eq!(EnvelopeMagic::MSRT.bytes(), [0xA5]);
    assert_eq!(envelope.packet_bytes, &payload);
    assert!(envelope.has_valid_len());
    assert!(envelope.header.has_valid_header_crc());
    assert_eq!(envelope.header.packet_len, 3);
}

#[test]
fn facade_exposes_reliability_fragment_view() {
    let header = PacketHeader::data(
        PacketIndex::new(0),
        Flags::ACK_ELICITING,
        ChannelId::new(7),
        MessageId::new(9),
        8,
        2,
    );

    let fragment = MessageFragment::try_from_packet_header(header, 4).unwrap();

    assert_eq!(
        fragment.key,
        MessageKey::new(ChannelId::new(7), MessageId::new(9))
    );
    assert_eq!(fragment.range, FragmentRange::new(2, 4));
}

#[test]
fn facade_exposes_concrete_engine_api() {
    let mut engine = Engine::default();
    let mut tx_buf = [0; TX_BUF_BYTES];
    let message_id = engine.send(b"hello").unwrap();

    assert_eq!(message_id, MessageId::ZERO);

    let EnginePoll::Transmit { bytes, .. } = engine.poll(0, &mut tx_buf).unwrap() else {
        panic!("engine should produce transmit bytes");
    };

    assert_eq!(
        bytes[msrt::wire::WIRE_HEADER_LEN + 2],
        ChannelId::DEFAULT.get()
    );
    assert_eq!(
        u16::from_le_bytes(
            bytes[msrt::wire::WIRE_HEADER_LEN + 7..msrt::wire::WIRE_HEADER_LEN + 9]
                .try_into()
                .unwrap()
        ),
        PacketIndex::ZERO.get()
    );
    assert!(!bytes.is_empty());
}

#[test]
fn facade_exposes_reliability_policy_types() {
    let channel_id = ChannelId::new(3);
    let policy = ChannelReliability::new(channel_id, ReliabilityMode::LatestOnly, 1, Some(100));

    assert_eq!(policy.channel_id, channel_id);
    assert_eq!(policy.mode, ReliabilityMode::LatestOnly);
}