boomnet 0.0.78

Framework for building low latency clients on top of TCP.
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use crate::buffer::{BufferPoolRef, OwnedReadBuffer};
use crate::util::into_array;
use crate::ws::{Error, WebsocketFrame, protocol};
use std::io;
use std::io::Read;

#[derive(Debug)]
pub struct Decoder {
    buffer: OwnedReadBuffer<4096>,
    decode_state: DecodeState,
    fin: bool,
    payload_length: usize,
    op_code: u8,
    needs_more_data: bool,
}

#[derive(Debug)]
enum DecodeState {
    ReadingHeader,
    ReadingPayloadLength,
    ReadingExtendedPayloadLength2,
    ReadingExtendedPayloadLength8,
    ReadingPayload,
}

impl Decoder {
    pub fn new(pool: &mut BufferPoolRef) -> Self {
        Self {
            buffer: pool.acquire(),
            decode_state: DecodeState::ReadingHeader,
            fin: false,
            op_code: 0,
            payload_length: 0,
            needs_more_data: true,
        }
    }

    #[inline]
    pub fn read<S: Read>(&mut self, stream: &mut S) -> io::Result<()> {
        if self.needs_more_data {
            self.buffer.read_all_from(stream)?;
            self.needs_more_data = false;
        }
        Ok(())
    }

    #[inline]
    pub fn decode_next(&mut self) -> Result<Option<WebsocketFrame>, Error> {
        loop {
            let available = self.buffer.available();
            match self.decode_state {
                DecodeState::ReadingHeader => {
                    if available > 0 {
                        // SAFETY: available > 0
                        let b = unsafe { self.buffer.consume_next_byte_unchecked() };
                        let fin = ((b & protocol::FIN_MASK) >> 7) == 1;
                        let rsv1 = (b & protocol::RSV1_MASK) >> 6;
                        let rsv2 = (b & protocol::RSV2_MASK) >> 5;
                        let rsv3 = (b & protocol::RSV3_MASK) >> 4;
                        if rsv1 + rsv2 + rsv3 != 0 {
                            return Err(Error::Protocol("non zero RSV value received".to_string()));
                        }
                        self.fin = fin;
                        let op_code = b & protocol::OP_CODE_MASK;
                        self.op_code = op_code;
                        self.decode_state = DecodeState::ReadingPayloadLength
                    } else {
                        break;
                    }
                }
                DecodeState::ReadingPayloadLength => {
                    if available > 0 {
                        // SAFETY: available > 0
                        let b = unsafe { self.buffer.consume_next_byte_unchecked() };
                        let mask = (b & protocol::MASK_MASK) >> 7;
                        if mask == 1 {
                            return Err(Error::Protocol("masking bit set on the server frame".to_string()));
                        }
                        let payload_length = b & protocol::PAYLOAD_LENGTH_MASK;
                        self.payload_length = payload_length as usize;
                        match payload_length {
                            0..=125 => self.decode_state = DecodeState::ReadingPayload,
                            126 => self.decode_state = DecodeState::ReadingExtendedPayloadLength2,
                            127 => self.decode_state = DecodeState::ReadingExtendedPayloadLength8,
                            // we only use 7 bits
                            _ => unsafe { std::hint::unreachable_unchecked() },
                        }
                    } else {
                        break;
                    }
                }
                DecodeState::ReadingExtendedPayloadLength2 => {
                    if available >= 2 {
                        // SAFETY: available >= 2
                        let bytes = unsafe { self.buffer.consume_next_unchecked(2) };
                        // SAFETY: we know bytes length is 2
                        let payload_length = u16::from_be_bytes(unsafe { into_array(bytes) });
                        self.payload_length = payload_length as usize;
                        self.decode_state = DecodeState::ReadingPayload;
                    } else {
                        break;
                    }
                }
                DecodeState::ReadingExtendedPayloadLength8 => {
                    if available >= 8 {
                        // SAFETY: available >= 8
                        let bytes = unsafe { self.buffer.consume_next_unchecked(8) };
                        // SAFETY: we know bytes length is 8
                        let payload_length = u64::from_be_bytes(unsafe { into_array(bytes) });
                        self.payload_length = payload_length as usize;
                        self.decode_state = DecodeState::ReadingPayload;
                    } else {
                        break;
                    }
                }
                DecodeState::ReadingPayload => {
                    let payload_length = self.payload_length;
                    if available >= payload_length {
                        // SAFETY: available >= payload_length
                        let payload = unsafe { self.buffer.consume_next_unchecked(payload_length) };
                        let frame = match self.op_code {
                            protocol::op::TEXT_FRAME => WebsocketFrame::Text(self.fin, payload),
                            protocol::op::BINARY_FRAME => WebsocketFrame::Binary(self.fin, payload),
                            protocol::op::CONTINUATION_FRAME => WebsocketFrame::Continuation(self.fin, payload),
                            protocol::op::PING => WebsocketFrame::Ping(payload),
                            protocol::op::PONG => WebsocketFrame::Pong(payload),
                            protocol::op::CONNECTION_CLOSE => WebsocketFrame::Close(payload),
                            _ => return Err(Error::Protocol(format!("unknown op_code: {}", self.op_code))),
                        };
                        self.decode_state = DecodeState::ReadingHeader;
                        return Ok(Some(frame));
                    } else {
                        break;
                    }
                }
            }
        }

        // await for more data
        self.needs_more_data = true;
        Ok(None)
    }
}