irtt-client 0.5.3

IRTT-compatible Rust client library
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use super::*;

#[test]
fn recv_once_returns_empty_on_timeout() {
    let params = default_params();
    let server = open_success_server(params);
    let config = ClientConfig {
        socket_config: crate::SocketConfig {
            recv_timeout: Some(Duration::from_millis(50)),
            ..Default::default()
        },
        ..default_test_config(server.addr)
    };
    let mut client = Client::connect(config).unwrap();
    assert_open_started(client.open().unwrap());
    let events = client.recv_once().unwrap();
    assert!(events.is_empty());
    server.join();
}

#[test]
fn recv_once_decodes_echo_reply_and_emits_event() {
    let params = default_params();
    let (mut client, server) = open_client_with_echo_server(&params);

    client.send_probe().unwrap();
    thread::sleep(Duration::from_millis(50));

    let events = client.recv_once().unwrap();
    assert_eq!(events.len(), 1);
    match &events[0] {
        ClientEvent::EchoReply {
            seq,
            rtt,
            received_stats,
            server_timing,
            bytes,
            packet_meta,
            ..
        } => {
            assert_eq!(*seq, 0);
            assert_eq!(*bytes, echo_packet_len(false, &params));
            assert!(rtt.raw > Duration::ZERO);
            assert_eq!(
                rtt.effective,
                rtt.adjusted
                    .unwrap_or_else(|| SignedDuration::from_duration(rtt.raw))
            );
            assert!(received_stats.is_some());
            let stats = received_stats.as_ref().unwrap();
            assert_eq!(stats.count, Some(42));
            assert_eq!(stats.window, Some(0x07));
            assert!(server_timing.is_some());
            let st = server_timing.as_ref().unwrap();
            assert!(st.processing.is_some());
            #[cfg(not(all(target_os = "linux", feature = "ancillary")))]
            {
                assert_eq!(packet_meta.traffic_class, None);
                assert_eq!(packet_meta.dscp, None);
                assert_eq!(packet_meta.ecn, None);
                assert_eq!(packet_meta.kernel_rx_timestamp, None);
            }
            #[cfg(all(target_os = "linux", feature = "ancillary"))]
            {
                assert_eq!(
                    packet_meta.dscp,
                    packet_meta.traffic_class.map(|tc| tc >> 2)
                );
                assert_eq!(
                    packet_meta.ecn,
                    packet_meta.traffic_class.map(|tc| tc & 0b11)
                );
            }
        }
        other => panic!("expected EchoReply, got {other:?}"),
    }
    client.close().unwrap();
    server.join();
}

#[test]
fn recv_once_decodes_only_received_bytes_after_longer_datagram() {
    let params = default_params();
    let server_params = params.clone();
    let server = start_fake_server(move |socket, tx| {
        let (_, peer) = recv_request(&socket, &tx);
        let reply = open_reply(FLAG_OPEN | FLAG_REPLY, TOKEN, &server_params, None);
        socket.send_to(&reply, peer).unwrap();

        let mut seqs = Vec::new();
        for _ in 0..2 {
            let (packet, _) = recv_request(&socket, &tx);
            seqs.push(u32::from_le_bytes(packet[12..16].try_into().unwrap()));
        }

        let mut longer = echo_reply_packet(
            TOKEN,
            seqs[0],
            &server_params,
            &TimestampFields::default(),
            None,
        );
        longer.extend_from_slice(b"trailing bytes");
        socket.send_to(&longer, peer).unwrap();

        let shorter = echo_reply_packet(
            TOKEN,
            seqs[1],
            &server_params,
            &TimestampFields::default(),
            None,
        );
        socket.send_to(&shorter, peer).unwrap();
    });
    let config = ClientConfig {
        socket_config: crate::SocketConfig {
            recv_timeout: Some(Duration::from_millis(200)),
            ..Default::default()
        },
        ..default_test_config(server.addr)
    };
    let mut client = Client::connect(config).unwrap();
    assert_open_started(client.open().unwrap());

    client.send_probe().unwrap();
    client.send_probe().unwrap();
    thread::sleep(Duration::from_millis(50));

    let _ = client.recv_once().unwrap();
    let events = client.recv_once().unwrap();
    assert_eq!(events.len(), 1);
    match &events[0] {
        ClientEvent::EchoReply { seq, bytes, .. } => {
            assert_eq!(*seq, 1);
            assert_eq!(*bytes, echo_packet_len(false, &params));
        }
        other => panic!("expected EchoReply after shorter datagram, got {other:?}"),
    }
    server.join();
}