rust_mqtt/network/
mod.rs

1/*
2 * MIT License
3 *
4 * Copyright (c) [2022] [Ondrej Babec <ond.babec@gmail.com>]
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24
25use crate::packet::v5::reason_codes::ReasonCode;
26use embedded_io::ReadReady;
27use embedded_io_async::{Read, Write};
28
29pub struct NetworkConnection<T>
30where
31    T: Read + Write,
32{
33    io: T,
34}
35
36/// Network connection represents an established TCP connection.
37impl<T> NetworkConnection<T>
38where
39    T: Read + Write,
40{
41    /// Create a new network handle using the provided IO implementation.
42    pub fn new(io: T) -> Self {
43        Self { io }
44    }
45
46    /// Send the data from `buffer` via TCP connection.
47    pub async fn send(&mut self, buffer: &[u8]) -> Result<(), ReasonCode> {
48        self.io
49            .write_all(buffer)
50            .await
51            .map_err(|_| ReasonCode::NetworkError)?;
52
53        self.io
54            .flush()
55            .await
56            .map_err(|_| ReasonCode::NetworkError)?;
57
58        Ok(())
59    }
60
61    /// Receive data to the `buffer` from TCP connection.
62    pub async fn receive(&mut self, buffer: &mut [u8]) -> Result<usize, ReasonCode> {
63        self.io
64            .read(buffer)
65            .await
66            .map_err(|_| ReasonCode::NetworkError)
67    }
68}
69
70/// Network connection represents an established TCP connection.
71impl<T> NetworkConnection<T>
72where
73    T: Read + Write + ReadReady,
74{
75    /// Check whether the TCP connection is ready to provide any data
76    pub fn receive_ready(&mut self) -> Result<bool, ReasonCode> {
77        self.io.read_ready().map_err(|_| ReasonCode::NetworkError)
78    }
79}