async_mqtt 9.0.1
Loading...
Searching...
No Matches
v5_pubrec.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_PUBREC_HPP)
8#define ASYNC_MQTT_PACKET_V5_PUBREC_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
54template <std::size_t PacketIdBytes>
56public:
57
68 pubrec_reason_code reason_code,
70 );
71
78 );
79
88 pubrec_reason_code reason_code
89 );
90
95 static constexpr control_packet_type type() {
97 }
98
104 std::vector<as::const_buffer> const_buffer_sequence() const;
105
110 std::size_t size() const;
111
116 std::size_t num_of_const_buffer_sequence() const;
117
123
129
134 properties const& props() const;
135
142 friend
143 std::ostream& operator<<(std::ostream& o, basic_pubrec_packet<PacketIdBytes> const& v) {
144 o <<
145 "v5::pubrec{" <<
146 "pid:" << v.packet_id();
147 if (v.reason_code_) {
148 o << ",rc:" << *v.reason_code_;
149 }
150 if (!v.props().empty()) {
151 o << ",ps:" << v.props();
152 };
153 o << "}";
154 return o;
155 }
156
157private:
158 explicit basic_pubrec_packet(
160 std::optional<pubrec_reason_code> reason_code,
162 );
163
164private:
165
166 template <std::size_t PacketIdBytesArg>
169
170#if defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
171 friend struct ::ut_packet::v5_pubrec;
172 friend struct ::ut_packet::v5_pubrec_pid4;
173 friend struct ::ut_packet::v5_pubrec_pid_only;
174 friend struct ::ut_packet::v5_pubrec_pid_rc;
175 friend struct ::ut_packet::v5_pubrec_prop_len_last;
176 friend struct ::ut_packet::v5_pubrec_error;
177#endif // defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
178
179 // private constructor for internal use
180 explicit basic_pubrec_packet(buffer buf, error_code& ec);
181
182private:
183 std::uint8_t fixed_header_;
184 std::size_t remaining_length_;
185 static_vector<char, 4> remaining_length_buf_;
186 static_vector<char, PacketIdBytes> packet_id_;
187
188 std::optional<pubrec_reason_code> reason_code_;
189
190 std::size_t property_length_ = 0;
191 static_vector<char, 4> property_length_buf_;
192 properties props_;
193};
194
207template <std::size_t PacketIdBytes>
209
222template <std::size_t PacketIdBytes>
224
236
237} // namespace async_mqtt::v5
238
239#if !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
240#include <async_mqtt/packet/impl/v5_pubrec.ipp>
241#endif // !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
242
243#endif // ASYNC_MQTT_PACKET_V5_PUBREC_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 PUBREC packet (v5)
Definition v5_pubrec.hpp:55
std::vector< as::const_buffer > const_buffer_sequence() const
Create const buffer sequence it is for boost asio APIs.
pubrec_reason_code code() const
Get reason code.
static constexpr control_packet_type type()
Get MQTT control packet type.
Definition v5_pubrec.hpp:95
friend std::ostream & operator<<(std::ostream &o, basic_pubrec_packet< PacketIdBytes > const &v)
stream output operator
Definition v5_pubrec.hpp:143
basic_pubrec_packet(typename basic_packet_id_type< PacketIdBytes >::type packet_id, pubrec_reason_code reason_code)
constructor
basic_pubrec_packet(typename basic_packet_id_type< PacketIdBytes >::type packet_id, pubrec_reason_code reason_code, properties props)
constructor
std::size_t num_of_const_buffer_sequence() const
Get number of element of const_buffer_sequence.
properties const & props() const
Get properties.
basic_packet_id_type< PacketIdBytes >::type packet_id() const
Get packet_id.
std::size_t size() const
Get packet size.
bool operator==(basic_pubrec_packet< PacketIdBytes > const &lhs, basic_pubrec_packet< PacketIdBytes > const &rhs)
equal operator
basic_pubrec_packet(typename basic_packet_id_type< PacketIdBytes >::type packet_id)
constructor
bool operator<(basic_pubrec_packet< PacketIdBytes > const &lhs, basic_pubrec_packet< PacketIdBytes > const &rhs)
less than operator
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
pubrec_reason_code
pubrec reason code It is reported as PUBLISH (QoS2) response via PUBREC packet
Definition error.hpp:800
packet idenfitifer type class template
Definition packet_id_type.hpp:25