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

//! Retransmission policy boundary.

use crate::core::PacketKey;

use super::TimeoutEvent;

/// Decision made after a packet timeout or reliability check.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum RetransmitDecision {
    /// Retransmit the packet.
    Retransmit {
        /// Packet selected for retransmission.
        key: PacketKey,
    },
    /// Keep waiting; do not retransmit yet.
    Wait {
        /// Packet that remains in flight.
        key: PacketKey,
    },
    /// Drop the packet from reliability tracking.
    Drop {
        /// Packet removed from tracking.
        key: PacketKey,
    },
}

/// Chooses whether timed-out packets should be retransmitted.
pub trait RetransmitPolicy {
    /// Applies a timeout event and returns the retransmission decision.
    fn on_timeout(&mut self, event: TimeoutEvent) -> RetransmitDecision;

    /// Returns whether a packet is currently eligible for retransmission.
    fn should_retransmit(&self, key: PacketKey) -> bool;
}

/// Retry-limit retransmission policy.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct RetryLimitPolicy {
    /// Maximum retransmission attempts before a packet is dropped.
    pub max_attempts: u8,
}

impl RetryLimitPolicy {
    /// Creates a retry-limit policy.
    #[must_use]
    pub const fn new(max_attempts: u8) -> Self {
        Self { max_attempts }
    }
}

impl RetransmitPolicy for RetryLimitPolicy {
    fn on_timeout(&mut self, event: TimeoutEvent) -> RetransmitDecision {
        if event.attempts < self.max_attempts {
            RetransmitDecision::Retransmit { key: event.key }
        } else {
            RetransmitDecision::Drop { key: event.key }
        }
    }

    fn should_retransmit(&self, _key: PacketKey) -> bool {
        self.max_attempts > 0
    }
}

#[cfg(test)]
mod tests {
    use crate::core::{ChannelId, MessageId, PacketIndex, PacketKey};

    use super::{RetransmitDecision, RetransmitPolicy, RetryLimitPolicy, TimeoutEvent};

    #[test]
    fn retry_limit_policy_drops_after_limit() {
        let key = PacketKey::new(ChannelId::DEFAULT, MessageId::new(3), PacketIndex::ZERO);
        let mut policy = RetryLimitPolicy::new(2);

        assert_eq!(
            policy.on_timeout(TimeoutEvent::new(key, 10, 1)),
            RetransmitDecision::Retransmit { key }
        );
        assert_eq!(
            policy.on_timeout(TimeoutEvent::new(key, 20, 2)),
            RetransmitDecision::Drop { key }
        );
    }
}