async_mqtt 9.0.1
Loading...
Searching...
No Matches
v3_1_1_subscribe.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_V3_1_1_SUBSCRIBE_HPP)
8#define ASYNC_MQTT_PACKET_V3_1_1_SUBSCRIBE_HPP
9
10#include <async_mqtt/buffer_to_packet_variant.hpp>
11#include <async_mqtt/util/buffer.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/topic_subopts.hpp>
16
17#include <async_mqtt/util/static_vector.hpp>
18#include <async_mqtt/util/variable_bytes.hpp>
19
30namespace async_mqtt::v3_1_1 {
31
32namespace as = boost::asio;
33
51template <std::size_t PacketIdBytes>
53public:
54
63 std::vector<topic_subopts> params
64 );
65
70 static constexpr control_packet_type type() {
72 }
73
79 std::vector<as::const_buffer> const_buffer_sequence() const;
80
85 std::size_t size() const;
86
91 std::size_t num_of_const_buffer_sequence() const;
92
98
103 std::vector<topic_subopts> const& entries() const;
104
105private:
106
107 template <std::size_t PacketIdBytesArg>
110
111#if defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
112 friend struct ::ut_packet::v311_subscribe;
113 friend struct ::ut_packet::v311_subscribe_pid4;
114 friend struct ::ut_packet::v311_subscribe_error;
115#endif // defined(ASYNC_MQTT_UNIT_TEST_FOR_PACKET)
116
117 // private constructor for internal use
118 explicit basic_subscribe_packet(buffer buf, error_code& ec);
119
120private:
121 std::uint8_t fixed_header_;
122 std::vector<static_vector<char, 2>> topic_length_buf_entries_;
123 std::vector<topic_subopts> entries_;
124 static_vector<char, PacketIdBytes> packet_id_ = static_vector<char, PacketIdBytes>(PacketIdBytes);
125 std::size_t remaining_length_;
126 static_vector<char, 4> remaining_length_buf_;
127};
128
141template <std::size_t PacketIdBytes>
143
156template <std::size_t PacketIdBytes>
158
171template <std::size_t PacketIdBytes>
172std::ostream& operator<<(std::ostream& o, basic_subscribe_packet<PacketIdBytes> const& v);
173
185
186} // namespace async_mqtt::v3_1_1
187
188#if !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
189#include <async_mqtt/packet/impl/v3_1_1_subscribe.ipp>
190#endif // !defined(ASYNC_MQTT_SEPARATE_COMPILATION)
191
192#endif // ASYNC_MQTT_PACKET_V3_1_1_SUBSCRIBE_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 SUBSCRIBE packet (v3.1.1)
Definition v3_1_1_subscribe.hpp:52
basic_subscribe_packet(typename basic_packet_id_type< PacketIdBytes >::type packet_id, std::vector< topic_subopts > params)
constructor
static constexpr control_packet_type type()
Get MQTT control packet type.
Definition v3_1_1_subscribe.hpp:70
std::ostream & operator<<(std::ostream &o, basic_subscribe_packet< PacketIdBytes > const &v)
stream output operator
std::size_t num_of_const_buffer_sequence() const
Get number of element of const_buffer_sequence.
std::size_t size() const
Get packet size.
bool operator==(basic_subscribe_packet< PacketIdBytes > const &lhs, basic_subscribe_packet< PacketIdBytes > const &rhs)
equal operator
std::vector< topic_subopts > const & entries() const
Get entries.
bool operator<(basic_subscribe_packet< PacketIdBytes > const &lhs, basic_subscribe_packet< PacketIdBytes > const &rhs)
less than operator
basic_packet_id_type< PacketIdBytes >::type packet_id() const
Get packet_id.
std::vector< as::const_buffer > const_buffer_sequence() const
Create const buffer sequence it is for boost asio APIs.
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
packet idenfitifer type class template
Definition packet_id_type.hpp:25