async_mqtt 9.0.1
Loading...
Searching...
No Matches
v5_unsuback.hpp
1// Copyright Takatoshi Kondo 2022
2//
3// Distributed under the Boost Software License, Version 1.0.
4// (See accompanying file LICENSE_1_0.txt or copy at
5// http://www.boost.org/LICENSE_1_0.txt)
6
7#if !defined(ASYNC_MQTT_PACKET_V5_UNSUBACK_HPP)
8#define ASYNC_MQTT_PACKET_V5_UNSUBACK_HPP
9
10#include <async_mqtt/buffer_to_packet_variant.hpp>
11#include <async_mqtt/error.hpp>
12
13#include <async_mqtt/packet/control_packet_type.hpp>
14#include <async_mqtt/packet/packet_id_type.hpp>
15#include <async_mqtt/packet/property_variant.hpp>
16
17#include <async_mqtt/util/buffer.hpp>
18#include <async_mqtt/util/static_vector.hpp>
19
30namespace async_mqtt::v5 {
31
32namespace as = boost::asio;
33
51template <std::size_t PacketIdBytes>
53public:
54
64 std::vector<unsuback_reason_code> params,
65 properties props = {}
66 );
67
72 static constexpr control_packet_type type() {
74 }
75
81 std::vector<as::const_buffer> const_buffer_sequence() const;
82
87 std::size_t size() const;
88
93 std::size_t num_of_const_buffer_sequence() const;
94
100
105 std::vector<unsuback_reason_code> const& entries() const;
106
111 properties const& props() const;
112
113private:
114
115 template <std::size_t PacketIdBytesArg>
118
119#if defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
120 friend struct ::ut_packet::v5_unsuback;
121 friend struct ::ut_packet::v5_unsuback_pid4;
122 friend struct ::ut_packet::v5_unsuback_error;
123#endif // defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
124
125 // private constructor for internal use
126 explicit basic_unsuback_packet(buffer buf, error_code& ec);
127
128private:
129 std::uint8_t fixed_header_;
130 std::vector<unsuback_reason_code> entries_;
131 static_vector<char, PacketIdBytes> packet_id_ = static_vector<char, PacketIdBytes>(PacketIdBytes);
132 std::size_t remaining_length_;
133 static_vector<char, 4> remaining_length_buf_;
134
135 std::size_t property_length_ = 0;
136 static_vector<char, 4> property_length_buf_;
137 properties props_;
138};
139
152template <std::size_t PacketIdBytes>
154
167template <std::size_t PacketIdBytes>
169
182template <std::size_t PacketIdBytes>
183std::ostream& operator<<(std::ostream& o, basic_unsuback_packet<PacketIdBytes> const& v);
184
196
197} // namespace async_mqtt::v5
198
199#if !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
200#include <async_mqtt/packet/impl/v5_unsuback.ipp>
201#endif // !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
202
203#endif // ASYNC_MQTT_PACKET_V5_UNSUBACK_HPP
The varaint type of all packets and system_error.
Definition packet_variant_fwd.hpp:37
buffer that has string_view interface and shared ownership This class is only for advanced usecase su...
Definition buffer.hpp:46
MQTT UNSUBACK packet (v5)
Definition v5_unsuback.hpp:52
std::vector< as::const_buffer > const_buffer_sequence() const
Create const buffer sequence it is for boost asio APIs.
std::size_t num_of_const_buffer_sequence() const
Get number of element of const_buffer_sequence.
bool operator==(basic_unsuback_packet< PacketIdBytes > const &lhs, basic_unsuback_packet< PacketIdBytes > const &rhs)
equal operator
std::size_t size() const
Get packet size.
bool operator<(basic_unsuback_packet< PacketIdBytes > const &lhs, basic_unsuback_packet< PacketIdBytes > const &rhs)
less than operator
std::ostream & operator<<(std::ostream &o, basic_unsuback_packet< PacketIdBytes > const &v)
stream output operator
static constexpr control_packet_type type()
Get MQTT control packet type.
Definition v5_unsuback.hpp:72
basic_packet_id_type< PacketIdBytes >::type packet_id() const
Get packet_id.
basic_unsuback_packet(typename basic_packet_id_type< PacketIdBytes >::type packet_id, std::vector< unsuback_reason_code > params, properties props={})
constructor
properties const & props() const
Get properties.
std::vector< unsuback_reason_code > const & entries() const
Get entries.
sys::error_code error_code
sys is a namespace alias of boost::sytem.
Definition error.hpp:56
protocol_version
MQTT protocol version.
Definition protocol_version.hpp:29
basic_packet_variant< PacketIdBytes > buffer_to_basic_packet_variant(buffer buf, protocol_version ver, error_code &ec)
create basic_packet_variant from the buffer
control_packet_type
MQTT control packet type.
Definition control_packet_type.hpp:26
std::vector< property_variant > properties
property variant collection type
Definition property_variant.hpp:224
packet idenfitifer type class template
Definition packet_id_type.hpp:25