async_mqtt::v5::basic_unsubscribe_packet< PacketIdBytes > Class Template Reference

MQTT UNSUBSCRIBE packet (v5) More...

#include <v5_unsubscribe.hpp>

Public Member Functions
	basic_unsubscribe_packet (packet_id_t packet_id, std::vector< topic_sharename > params, properties props={})
	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< topic_sharename > const &	entries () const
	Get entries.
properties const &	props () const

Detailed Description

template<std::size_t PacketIdBytes>
class async_mqtt::v5::basic_unsubscribe_packet< PacketIdBytes >

MQTT UNSUBSCRIBE packet (v5)

Template Parameters

PacketIdBytes

size of packet_id

MQTT UNSUBSCRIBE packet.
See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901179

Constructor & Destructor Documentation

basic_unsubscribe_packet()

template<std::size_t PacketIdBytes>

async_mqtt::v5::basic_unsubscribe_packet< PacketIdBytes >::basic_unsubscribe_packet ( packet_id_t packet_id, std::vector< topic_sharename > params, properties props = {} )

inline

constructor

Parameters

packet_id	MQTT PacketIdentifier.the packet_id must be acquired by basic_endpoint::acquire_unique_packet_id().
params	unsubscribe entries.
props	properties. See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901182

Member Function Documentation

const_buffer_sequence()

template<std::size_t PacketIdBytes>

std::vector< as::const_buffer > async_mqtt::v5::basic_unsubscribe_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< topic_sharename > const & async_mqtt::v5::basic_unsubscribe_packet< PacketIdBytes >::entries ( ) const

inline

Get entries.

Returns

entries

num_of_const_buffer_sequence()

template<std::size_t PacketIdBytes>

std::size_t async_mqtt::v5::basic_unsubscribe_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::v5::basic_unsubscribe_packet< PacketIdBytes >::packet_id ( ) const

inline

Get packet_id.

Returns

packet_id

props()

template<std::size_t PacketIdBytes>

properties const & async_mqtt::v5::basic_unsubscribe_packet< PacketIdBytes >::props ( ) const

inline

@breif Get properties

Returns

properties

size()

template<std::size_t PacketIdBytes>

std::size_t async_mqtt::v5::basic_unsubscribe_packet< PacketIdBytes >::size ( ) const

inline

Get packet size.

Returns

packet size

---

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

• /home/kondo/work/async_mqtt/include/async_mqtt/packet/packet_traits.hpp
• /home/kondo/work/async_mqtt/include/async_mqtt/packet/v5_unsubscribe.hpp