rust_mqtt/packet/v5/
disconnect_packet.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 heapless::Vec;
26
27use crate::encoding::variable_byte_integer::VariableByteIntegerEncoder;
28use crate::packet::v5::mqtt_packet::Packet;
29use crate::utils::buffer_reader::BuffReader;
30use crate::utils::buffer_writer::BuffWriter;
31use crate::utils::types::BufferError;
32
33use super::packet_type::PacketType;
34use super::property::Property;
35
36pub struct DisconnectPacket<'a, const MAX_PROPERTIES: usize> {
37    // 7 - 4 mqtt control packet type, 3-0 flagy
38    pub fixed_header: u8,
39    // 1 - 4 B lenght of variable header + len of payload
40    pub remain_len: u32,
41
42    pub disconnect_reason: u8,
43
44    pub property_len: u32,
45
46    pub properties: Vec<Property<'a>, MAX_PROPERTIES>,
47}
48
49impl<'a, const MAX_PROPERTIES: usize> DisconnectPacket<'a, MAX_PROPERTIES> {
50    fn add_reason(&mut self, reason: u8) {
51        self.disconnect_reason = reason;
52    }
53}
54
55impl<'a, const MAX_PROPERTIES: usize> Packet<'a> for DisconnectPacket<'a, MAX_PROPERTIES> {
56    fn new() -> Self {
57        Self {
58            fixed_header: PacketType::Disconnect.into(),
59            remain_len: 5,
60            disconnect_reason: 0x00,
61            property_len: 0,
62            properties: Vec::<Property<'a>, MAX_PROPERTIES>::new(),
63        }
64    }
65
66    fn encode(&mut self, buffer: &mut [u8], buffer_len: usize) -> Result<usize, BufferError> {
67        let mut buff_writer = BuffWriter::new(buffer, buffer_len);
68        buff_writer.write_u8(self.fixed_header)?;
69        let property_len_enc = VariableByteIntegerEncoder::encode(self.property_len)?;
70        let property_len_len = VariableByteIntegerEncoder::len(property_len_enc);
71
72        let rm_len: u32 = 1 + self.property_len + property_len_len as u32;
73        buff_writer.write_variable_byte_int(rm_len)?;
74        buff_writer.write_u8(self.disconnect_reason)?;
75        buff_writer.write_variable_byte_int(self.property_len)?;
76        buff_writer.write_properties(&self.properties)?;
77        Ok(buff_writer.position)
78    }
79
80    fn decode(&mut self, buff_reader: &mut BuffReader<'a>) -> Result<(), BufferError> {
81        if self.decode_fixed_header(buff_reader)? != PacketType::Disconnect {
82            error!("Packet you are trying to decode is not DISCONNECT packet!");
83            return Err(BufferError::WrongPacketToDecode);
84        }
85        if self.remain_len == 0 {
86            self.disconnect_reason = 0x00;
87            return Ok(());
88        }
89        self.disconnect_reason = buff_reader.read_u8()?;
90        self.decode_properties(buff_reader)
91    }
92
93    fn set_property_len(&mut self, value: u32) {
94        self.property_len = value;
95    }
96
97    fn get_property_len(&mut self) -> u32 {
98        self.property_len
99    }
100
101    fn push_to_properties(&mut self, property: Property<'a>) {
102        self.properties.push(property);
103    }
104
105    fn property_allowed(&mut self, property: &Property<'a>) -> bool {
106        property.disconnect_property()
107    }
108
109    fn set_fixed_header(&mut self, header: u8) {
110        self.fixed_header = header;
111    }
112
113    fn set_remaining_len(&mut self, remaining_len: u32) {
114        self.remain_len = remaining_len;
115    }
116}
rust_mqtt/packet/v5/disconnect_packet.rs

rust_mqtt/packet/v5/
disconnect_packet.rs
