async_mqtt 4.1.0
Loading...
Searching...
No Matches
async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes > Class Template Reference

MQTT SUBACK packet (v3.1.1) More...

#include <v3_1_1_suback.hpp>

Public Member Functions

 basic_suback_packet (packet_id_t packet_id, std::vector< suback_return_code > params)
 constructor
 
std::vector< as::const_buffer > const_buffer_sequence () const
 Create const buffer sequence it is for boost asio APIs.
 
std::size_t size () const
 Get packet size.
 
std::size_t num_of_const_buffer_sequence () const
 Get number of element of const_buffer_sequence.
 
packet_id_t packet_id () const
 Get packet_id.
 
std::vector< suback_return_code > constentries () const
 Get entries.
 

Related Symbols

(Note that these are not member symbols.)

using suback_packet = basic_suback_packet<2>
 Type alias of basic_suback_packet (PacketIdBytes=2).
 

Detailed Description

template<std::size_t PacketIdBytes>
class async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes >

MQTT SUBACK packet (v3.1.1)

Template Parameters
PacketIdBytessize of packet_id

MQTT SUBACK packet.
See http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718068

Constructor & Destructor Documentation

◆ basic_suback_packet()

template<std::size_t PacketIdBytes>
async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes >::basic_suback_packet ( packet_id_t packet_id,
std::vector< suback_return_code > params )
inline

constructor

Parameters
packet_idMQTT PacketIdentifier that is corresponding to the SUBSCRIBE packet
paramssuback entries.

Member Function Documentation

◆ const_buffer_sequence()

template<std::size_t PacketIdBytes>
std::vector< as::const_buffer > async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes >::const_buffer_sequence ( ) const
inline

Create const buffer sequence it is for boost asio APIs.

Returns
const buffer sequence

◆ entries()

template<std::size_t PacketIdBytes>
std::vector< suback_return_code > const & async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes >::entries ( ) const
inline

Get entries.

Returns
entries

◆ num_of_const_buffer_sequence()

template<std::size_t PacketIdBytes>
std::size_t async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes >::num_of_const_buffer_sequence ( ) const
inline

Get number of element of const_buffer_sequence.

Returns
number of element of const_buffer_sequence

◆ packet_id()

template<std::size_t PacketIdBytes>
packet_id_t async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes >::packet_id ( ) const
inline

Get packet_id.

Returns
packet_id

◆ size()

template<std::size_t PacketIdBytes>
std::size_t async_mqtt::v3_1_1::basic_suback_packet< PacketIdBytes >::size ( ) const
inline

Get packet size.

Returns
packet size

The documentation for this class was generated from the following files: