MQTT PUBCOMP packet (v5)
More...
#include <v5_pubcomp.hpp>
template<std::size_t PacketIdBytes>
class async_mqtt::v5::basic_pubcomp_packet< PacketIdBytes >
MQTT PUBCOMP packet (v5)
- Template Parameters
-
PacketIdBytes | size of packet_id |
If basic_endpoint::set_auto_pub_response() is called with true, then this packet is automatically sent when PUBREL v5::basic_pubrel_packet is received.
When the packet is received, the packet_id is automatically released and become reusable.
See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901151
Thread Safety
- Distinct objects: Safe
- Shared objects: Unsafe
Requirements
◆ basic_pubcomp_packet() [1/3]
template<std::size_t PacketIdBytes>
◆ basic_pubcomp_packet() [2/3]
template<std::size_t PacketIdBytes>
constructor
- Parameters
-
packet_id | MQTT PacketIdentifier that is corresponding to the PUBREL packet |
◆ basic_pubcomp_packet() [3/3]
template<std::size_t PacketIdBytes>
◆ code()
template<std::size_t PacketIdBytes>
Get reason code.
- Returns
- reason_code
◆ const_buffer_sequence()
template<std::size_t PacketIdBytes>
Create const buffer sequence it is for boost asio APIs.
- Returns
- const buffer sequence
◆ num_of_const_buffer_sequence()
template<std::size_t PacketIdBytes>
Get number of element of const_buffer_sequence.
- Returns
- number of element of const_buffer_sequence
◆ packet_id()
template<std::size_t PacketIdBytes>
Get packet_id.
- Returns
- packet_id
◆ props()
template<std::size_t PacketIdBytes>
Get properties.
- Returns
- properties
◆ size()
template<std::size_t PacketIdBytes>
Get packet size.
- Returns
- packet size
◆ type()
template<std::size_t PacketIdBytes>
Get MQTT control packet type.
- Returns
- control packet type
◆ operator<()
template<std::size_t PacketIdBytes>
less than operator
- Parameters
-
lhs | compare target |
rhs | compare target |
- Returns
- true if the lhs less than the rhs, otherwise false.
Requirements
◆ operator<<
template<std::size_t PacketIdBytes>
stream output operator
- Parameters
-
- Returns
- output stream
◆ operator==()
template<std::size_t PacketIdBytes>
equal operator
- Parameters
-
lhs | compare target |
rhs | compare target |
- Returns
- true if the lhs equal to the rhs, otherwise false.
Requirements
The documentation for this class was generated from the following files: