async_mqtt::v5::pingreq_packet Class Reference

MQTT PINGREQ packet (v5) More...

#include <v5_pingreq.hpp>

Public Member Functions
	pingreq_packet (buffer buf)
	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.

Static Public Member Functions
static constexpr std::size_t	num_of_const_buffer_sequence ()
	Get number of element of const_buffer_sequence.

Detailed Description

MQTT PINGREQ packet (v5)

Only MQTT client can send this packet. This packet is to notify the client is living. When you set keep_alive_sec > 0 on CONNECT packet (v5::connect_packet), then PINGREQ packet is automatically sent after keep_alive_sec passed after the last packet sent. When the broker receives this packet, KeepAlive timeout (keep_alive_sec * 1.5) is reset and start counting from 0.
See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901195

Member Function Documentation

const_buffer_sequence()

std::vector< as::const_buffer > async_mqtt::v5::pingreq_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()

static constexpr std::size_t async_mqtt::v5::pingreq_packet::num_of_const_buffer_sequence ( )

inlinestaticconstexpr

Get number of element of const_buffer_sequence.

Returns

number of element of const_buffer_sequence

size()

std::size_t async_mqtt::v5::pingreq_packet::size ( ) const

inline

Get packet size.

Returns

packet size

---

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

• /home/kondo/work/async_mqtt/include/async_mqtt/packet/v5_pingreq.hpp