msrt 0.1.1

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

//! Shared reliability policy descriptors.

use crate::core::ChannelId;

/// Reliability mode requested for a channel or message class.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ReliabilityMode {
    /// Require acknowledgement and allow retransmission.
    Reliable,
    /// Send without retransmission.
    BestEffort,
    /// Prefer the newest message and allow older messages to be dropped.
    LatestOnly,
    /// Retransmit only while the engine-defined deadline remains valid.
    Deadline,
}

/// Reliability configuration associated with one channel.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ChannelReliability {
    /// Channel this policy applies to.
    pub channel_id: ChannelId,
    /// Reliability mode for the channel.
    pub mode: ReliabilityMode,
    /// Maximum retransmission attempts allowed by this policy.
    pub max_retransmits: u8,
    /// Engine-defined deadline in ticks.
    pub deadline_ticks: Option<u64>,
}

impl ChannelReliability {
    /// Creates channel reliability configuration.
    #[must_use]
    pub const fn new(
        channel_id: ChannelId,
        mode: ReliabilityMode,
        max_retransmits: u8,
        deadline_ticks: Option<u64>,
    ) -> Self {
        Self {
            channel_id,
            mode,
            max_retransmits,
            deadline_ticks,
        }
    }

    /// Creates a reliable channel policy.
    #[must_use]
    pub const fn reliable(channel_id: ChannelId, max_retransmits: u8) -> Self {
        Self::new(channel_id, ReliabilityMode::Reliable, max_retransmits, None)
    }

    /// Creates a best-effort channel policy.
    #[must_use]
    pub const fn best_effort(channel_id: ChannelId) -> Self {
        Self::new(channel_id, ReliabilityMode::BestEffort, 0, None)
    }
}