async_mqtt 4.1.0
Loading...
Searching...
No Matches
async_mqtt::v5::connack_packet Class Reference

#include <v5_connack.hpp>

Public Member Functions

 connack_packet (bool session_present, connect_reason_code reason_code, properties props={})
 
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.
 
connect_reason_code code () const
 
properties constprops () const
 

Detailed Description

@bried MQTT CONNACK packet (v5)

Only MQTT broker(sever) can send this packet.
See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901074

Constructor & Destructor Documentation

◆ connack_packet()

async_mqtt::v5::connack_packet::connack_packet ( bool session_present,
connect_reason_code reason_code,
properties props = {} )
inline

@bried constructor

Parameters
session_presentIf the broker stores the session, then true, otherwise false. When the endpoint receives CONNACK packet with session_present is false, then stored packets are erased.
reason_codeConnectReasonCode
See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901079
propsproperties.
See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901080

Member Function Documentation

◆ code()

connect_reason_code async_mqtt::v5::connack_packet::code ( ) const
inline

@breif Get reason code

Returns
reason_code

◆ const_buffer_sequence()

std::vector< as::const_buffer > async_mqtt::v5::connack_packet::const_buffer_sequence ( ) const
inline

Create const buffer sequence it is for boost asio APIs.

Returns
const buffer sequence

◆ num_of_const_buffer_sequence()

std::size_t async_mqtt::v5::connack_packet::num_of_const_buffer_sequence ( ) const
inline

Get number of element of const_buffer_sequence.

Returns
number of element of const_buffer_sequence

◆ props()

properties const & async_mqtt::v5::connack_packet::props ( ) const
inline

@breif Get properties

Returns
properties

◆ size()

std::size_t async_mqtt::v5::connack_packet::size ( ) const
inline

Get packet size.

Returns
packet size

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