async_mqtt::v5::pingreq_packet Class Reference

MQTT PINGREQ packet (v5) More...

#include <v5_pingreq.hpp>

Public Member Functions
	pingreq_packet ()
	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 control_packet_type	type ()
	Get MQTT control packet type.
static constexpr std::size_t	num_of_const_buffer_sequence ()
	Get number of element of const_buffer_sequence.

Related Symbols
(Note that these are not member symbols.)
bool	operator< (pingreq_packet const &lhs, pingreq_packet const &rhs)
	less than operator
bool	operator== (pingreq_packet const &lhs, pingreq_packet const &rhs)
	equal operator
std::ostream &	operator<< (std::ostream &o, pingreq_packet const &v)
	stream output operator

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

Thread Safety

• Distinct objects: Safe
• Shared objects: Unsafe

Requirements

• Header: async_mqtt/packet/v5_pingreq.hpp
• Convenience header: async_mqtt/all.hpp

Member Function Documentation

const_buffer_sequence()

std::vector< as::const_buffer > async_mqtt::v5::pingreq_packet::const_buffer_sequence

(

)

const

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

Get packet size.

Returns

packet size

type()

static constexpr control_packet_type async_mqtt::v5::pingreq_packet::type ( )

inlinestaticconstexpr

Get MQTT control packet type.

Returns

control packet type

Friends And Related Symbol Documentation

operator<()

bool operator< ( pingreq_packet const & lhs, pingreq_packet const & rhs )

related

less than operator

Parameters

lhs	compare target
rhs	compare target

Returns

true if the lhs less than the rhs, otherwise false.

Requirements

• Header: async_mqtt/packet/v5_pingreq.hpp
• Convenience header: async_mqtt/all.hpp

operator<<()

std::ostream & operator<< ( std::ostream & o, pingreq_packet const & v )

related

stream output operator

Parameters

o	output stream
v	target

Returns

output stream

Requirements

• Header: async_mqtt/packet/v5_pingreq.hpp
• Convenience header: async_mqtt/all.hpp

operator==()

bool operator== ( pingreq_packet const & lhs, pingreq_packet const & rhs )

related

equal operator

Parameters

lhs	compare target
rhs	compare target

Returns

true if the lhs equal to the rhs, otherwise false.

Requirements

• Header: async_mqtt/packet/v5_pingreq.hpp
• Convenience header: async_mqtt/all.hpp

---

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

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