rammux 0.1.2

Asynchronous stream multiplexer
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

//! Types for working with virtual rammux streams.

use std::sync::{Arc, Mutex};

use crate::{
    StreamId,
    config::RammuxConfig,
    stream::{
        handle::StreamHandle, inbound::InboundTraffic, outbound::OutboundTraffic,
        updates::StreamUpdates, waker::WakerSlot,
    },
};

pub use duplex::{RammuxDuplex, RammuxSink, RammuxStream};

mod duplex;
pub(crate) mod handle;
mod inbound;
mod outbound;
#[cfg(test)]
mod test;
pub(crate) mod updates;
mod waker;

pub(crate) fn new(
    id: StreamId,
    is_outbound: bool,
    config: &RammuxConfig,
) -> (StreamHandle, StreamUpdates, RammuxDuplex) {
    let state = SharedStreamState {
        inbound: InboundTraffic::new(config.local_recv_window),
        outbound: OutboundTraffic::new(config.frame_limit, config.remote_recv_window),
        updates_poller: Default::default(),
    };
    let state = Arc::new(Mutex::new(state));

    (
        StreamHandle(state.clone()),
        StreamUpdates {
            id,
            syn: is_outbound,
            state: state.clone(),
        },
        RammuxDuplex {
            sink: RammuxSink {
                id,
                state: Some(state.clone()),
            },
            stream: RammuxStream {
                id,
                state: Some(state),
            },
        },
    )
}

/// State of a virtual stream, shared under [`Mutex`] by [`StreamHandle`], [`StreamUpdates`] and [`RammuxDuplex`].
struct SharedStreamState {
    /// State of the inbound traffic direction.
    inbound: InboundTraffic,
    /// State of the outbound traffic direction.
    outbound: OutboundTraffic,
    /// Waker for the task that polls [`StreamUpdates`].
    updates_poller: WakerSlot,
}

/// Represents the current `FIN_*` state of a virtual stream or one of its traffic directions.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub(crate) struct FinState {
    sent: bool,
    received: bool,
}

impl FinState {
    /// Returns whether all fins were sent and received.
    pub(crate) fn is_dead(self) -> bool {
        self.sent && self.received
    }

    fn and(self, other: Self) -> Self {
        Self {
            sent: self.sent && other.sent,
            received: self.received && other.received,
        }
    }
}