msrt 0.1.7

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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! Internal engine protocol state.

use crate::core::{MessageId, Result};
use crate::engine::{EngineConfig, EnginePoll, ReceiveReport};

use self::{
    ack::AckState, clock::ClockState, ingress::IngressState, message::MessageState,
    numbers::NumberState, reassembly::ReassemblyState, receive::ReceiveState,
    recovery::RecoveryState, scheduler::SchedulerState,
};

pub(crate) mod ack;
pub(crate) mod clock;
pub(crate) mod ingress;
pub(crate) mod message;
pub(crate) mod numbers;
pub(crate) mod reassembly;
pub(crate) mod receive;
pub(crate) mod recovery;
pub(crate) mod scheduler;
#[cfg(test)]
mod tests;

pub(crate) use scheduler::{EngineOutput, WriteEvent};

/// Internal protocol state owned by [`crate::engine::Engine`].
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct EngineState {
    pub(crate) clock: ClockState,
    pub(crate) numbers: NumberState,
    pub(crate) scheduler: SchedulerState,
    pub(crate) recovery: RecoveryState,
    pub(crate) ack: AckState,
    pub(crate) ingress: IngressState,
    pub(crate) message: MessageState,
    pub(crate) receive: ReceiveState,
    pub(crate) reassembly: ReassemblyState,
}

impl EngineState {
    pub(crate) const fn new(
        initial_message_id: MessageId,
        #[cfg_attr(not(feature = "dynamic-recovery"), allow(unused_variables))]
        config: &EngineConfig,
    ) -> Self {
        Self {
            clock: ClockState::new(),
            numbers: NumberState::new(initial_message_id),
            scheduler: SchedulerState::new(),
            #[cfg(not(feature = "dynamic-recovery"))]
            recovery: RecoveryState::new(),
            #[cfg(feature = "dynamic-recovery")]
            recovery: RecoveryState::new(config.dynamic_recovery),
            ack: AckState::new(),
            ingress: IngressState::new(),
            message: MessageState::new(),
            receive: ReceiveState::new(),
            reassembly: ReassemblyState::new(),
        }
    }

    pub(crate) fn poll<'a>(
        &mut self,
        config: &EngineConfig,
        now_ms: u64,
        tx_buf: &'a mut [u8],
    ) -> Result<EnginePoll<'a>> {
        self.tick_retransmit(config, now_ms);

        if self.ack.is_pending() {
            return self
                .scheduler
                .poll_ack(config, &mut self.ack, &mut self.numbers, tx_buf);
        }

        if let Some(event) = self.scheduler.pop_urgent() {
            return scheduler::poll_event(event, &mut self.recovery, now_ms, tx_buf);
        }

        if let Some(message) = self.message.pop() {
            return Ok(EnginePoll::Message(message));
        }

        self.scheduler
            .poll_new_data(&mut self.recovery, now_ms, tx_buf)
    }

    pub(crate) fn send_data(&mut self, config: &EngineConfig, message: &[u8]) -> Result<MessageId> {
        self.send_data_impl(config, message)
    }

    #[allow(dead_code)]
    pub(crate) fn send_log(&mut self, config: &EngineConfig, message: &[u8]) -> Result<MessageId> {
        self.send_log_impl(config, message)
    }

    pub(crate) fn send_ping(&mut self, config: &EngineConfig) -> Result<()> {
        self.send_ping_impl(config)
    }

    pub(crate) fn receive(&mut self, config: &EngineConfig, bytes: &[u8]) -> ReceiveReport {
        self.receive_ingress(config, bytes)
    }

    #[cfg(test)]
    pub(crate) fn poll_event(state: &mut EngineState) -> Option<EngineOutput> {
        state.scheduler.pop()
    }
}