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

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

use crate::{
    buffer::Data,
    error::StreamError,
    stream::{FinState, SharedStreamState},
};

/// Handle to a virtual rammux stream.
pub struct StreamHandle(pub(super) Arc<Mutex<SharedStreamState>>);

impl StreamHandle {
    /// Updates the state of this stream with a received `DATA` frame.
    ///
    /// Returns the new [`FinState`] of the whole stream.
    pub fn received_data(
        &mut self,
        data: Data,
        fin_read: bool,
        fin_write: bool,
    ) -> Result<FinState, StreamError> {
        let mut guard = self.0.lock().unwrap();
        let SharedStreamState {
            inbound,
            outbound,
            updates_poller,
        } = &mut *guard;
        inbound.received_data(data)?;
        if fin_write {
            inbound.received_fin_write(updates_poller)?;
        }
        if fin_read {
            outbound.received_fin_read(updates_poller)?;
        }
        Ok(inbound.fin_state().and(outbound.fin_state()))
    }

    /// Updates the state of this stream with a received `WINDOW_UPDATE` frame.
    ///
    /// Returns the new [`FinState`] of the whole stream.
    pub fn received_window_update(
        &mut self,
        update: u32,
        fin_read: bool,
        fin_write: bool,
    ) -> Result<FinState, StreamError> {
        let mut guard = self.0.lock().unwrap();
        let SharedStreamState {
            inbound,
            outbound,
            updates_poller,
        } = &mut *guard;
        outbound.received_window_update(update, updates_poller)?;
        if fin_read {
            outbound.received_fin_read(updates_poller)?;
        }
        if fin_write {
            inbound.received_fin_write(updates_poller)?;
        }
        Ok(inbound.fin_state().and(outbound.fin_state()))
    }

    /// Attempts to abort this stream.
    ///
    /// This is a noop if the stream is already dead or the internal mutex is poisoned.
    pub fn try_abort(self) {
        let Ok(mut guard) = self.0.lock() else {
            return;
        };
        let SharedStreamState {
            inbound,
            outbound,
            updates_poller,
        } = &mut *guard;
        let _ = inbound.received_fin_write(updates_poller);
        let _ = outbound.received_fin_read(updates_poller);
    }
}