Collaboration diagram for Property for MQTT v5.0 packets:

Topics
	implementation class

	variant class for all properties

Classes
class	async_mqtt::property::payload_format_indicator
	payload_format_indicator property More...

class	async_mqtt::property::message_expiry_interval
	message_expiry_interval property More...

class	async_mqtt::property::content_type
	content_type property More...

class	async_mqtt::property::response_topic
	response_topic property More...

class	async_mqtt::property::correlation_data
	correlation_data property More...

class	async_mqtt::property::subscription_identifier
	subscription_identifier property More...

class	async_mqtt::property::session_expiry_interval
	session_expiry_interval property More...

class	async_mqtt::property::assigned_client_identifier
	assigned_client_identifier property More...

class	async_mqtt::property::server_keep_alive
	server_keep_alive property More...

class	async_mqtt::property::authentication_method
	authentication_method property More...

class	async_mqtt::property::authentication_data
	authentication_data property More...

class	async_mqtt::property::request_problem_information
	request_problem_information property More...

class	async_mqtt::property::will_delay_interval
	will_delay_interval property More...

class	async_mqtt::property::request_response_information
	request_response_information property More...

class	async_mqtt::property::response_information
	response_information property More...

class	async_mqtt::property::server_reference
	server_reference property More...

class	async_mqtt::property::reason_string
	reason_string property More...

class	async_mqtt::property::receive_maximum
	receive_maximum property More...

class	async_mqtt::property::topic_alias_maximum
	topic_alias_maximum property More...

class	async_mqtt::property::topic_alias
	topic_alias property More...

class	async_mqtt::property::maximum_qos
	maximum_qos property More...

class	async_mqtt::property::retain_available
	retain_available property More...

class	async_mqtt::property::user_property
	user property More...

class	async_mqtt::property::maximum_packet_size
	maximum_packet_size property More...

class	async_mqtt::property::wildcard_subscription_available
	wildcard_subscription_available property More...

class	async_mqtt::property::subscription_identifier_available
	subscription_identifier_available property More...

class	async_mqtt::property::shared_subscription_available
	shared_subscription_available property More...

Typedefs
using	async_mqtt::session_expiry_interval_type = std::uint32_t
	type of the session expiry interval (seconds)

using	async_mqtt::topic_alias_type = std::uint16_t
	type of the topic alias value

using	async_mqtt::receive_maximum_type = std::uint16_t
	type of the receive maximum value

using	async_mqtt::properties = std::vector<property_variant>
	property variant collection type

Enumerations
enum class	async_mqtt::payload_format { payload_format::binary , payload_format::string }
	payload_format More...

enum class	async_mqtt::property::id { id::payload_format_indicator = 1 , id::message_expiry_interval = 2 , id::content_type = 3 , id::response_topic = 8 , id::correlation_data = 9 , id::subscription_identifier = 11 , id::session_expiry_interval = 17 , id::assigned_client_identifier = 18 , id::server_keep_alive = 19 , id::authentication_method = 21 , id::authentication_data = 22 , id::request_problem_information = 23 , id::will_delay_interval = 24 , id::request_response_information = 25 , id::response_information = 26 , id::server_reference = 28 , id::reason_string = 31 , id::receive_maximum = 33 , id::topic_alias_maximum = 34 , id::topic_alias = 35 , id::maximum_qos = 36 , id::retain_available = 37 , id::user_property = 38 , id::maximum_packet_size = 39 , id::wildcard_subscription_available = 40 , id::subscription_identifier_available = 41 , id::shared_subscription_available = 42 }
	MQTT property identifier. More...

Functions
template<typename Property >
std::enable_if_t< Property::of_==detail::ostream_format::direct, std::ostream & >	async_mqtt::property::operator<< (std::ostream &o, Property const &v)
	stream output operator

constexpr char const *	async_mqtt::property::id_to_str (id v)
	stringize packet identifier

std::ostream &	async_mqtt::property::operator<< (std::ostream &o, id v)
	output to the stream

Detailed Description

Typedef Documentation

◆ properties

using async_mqtt::properties = std::vector<property_variant>

property variant collection type

Requirements

Header: async_mqtt/packet/property_variant.hpp
Convenience header: async_mqtt/all.hpp

◆ receive_maximum_type

using async_mqtt::receive_maximum_type = std::uint16_t

type of the receive maximum value

Requirements

Header: async_mqtt/packet/property.hpp
Convenience header: async_mqtt/all.hpp

◆ session_expiry_interval_type

using async_mqtt::session_expiry_interval_type = std::uint32_t

type of the session expiry interval (seconds)

Requirements

Header: async_mqtt/packet/property.hpp
Convenience header: async_mqtt/all.hpp

◆ topic_alias_type

using async_mqtt::topic_alias_type = std::uint16_t

type of the topic alias value

Requirements

Header: async_mqtt/packet/property.hpp
Convenience header: async_mqtt/all.hpp

Enumeration Type Documentation

◆ id

enum class async_mqtt::property::id

strong

MQTT property identifier.

See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901029

Requirements

Header: async_mqtt/packet/property_id.hpp
Convenience header: async_mqtt/all.hpp

Enumerator
payload_format_indicator	Payload Format Indicator.
message_expiry_interval	Message Expiry Interval.
content_type	Content Type.
response_topic	Response Topic.
correlation_data	Correlation Data.
subscription_identifier	Subscription Identifier.
session_expiry_interval	Session Expiry Interval.
assigned_client_identifier	Assigned Client Identifier.
server_keep_alive	Server Keep Alive.
authentication_method	Authentication Method.
authentication_data	Authentication Data.
request_problem_information	Request Problem Information.
will_delay_interval	Will Delay Interval.
request_response_information	Request Response Information.
response_information	Response Information.
server_reference	Server Reference.
reason_string	Reason String.
receive_maximum	Receive Maximum.
topic_alias_maximum	Topic Alias Maximum.
topic_alias	Topic Alias.
maximum_qos	Maximum QoS.
retain_available	Retain Available.
user_property	User Property.
maximum_packet_size	Maximum Packet Size.
wildcard_subscription_available	Wildcard Subscription Available.
subscription_identifier_available	Subscription Identifier Available.
shared_subscription_available	Shared Subscription Available.

◆ payload_format

enum class async_mqtt::payload_format

strong

payload_format

Requirements

Header: async_mqtt/packet/property.hpp
Convenience header: async_mqtt/all.hpp

Enumerator
binary	binary
string	string

Function Documentation

◆ id_to_str()

char const * async_mqtt::property::id_to_str ( id v )

constexpr

stringize packet identifier

Parameters

v target

Returns: packet identifier

Requirements

Header: async_mqtt/packet/property_id.hpp
Convenience header: async_mqtt/all.hpp

◆ operator<<() [1/2]

std::ostream & async_mqtt::property::operator<<	(	std::ostream &	o,
		id	v )

inline

output to the stream

Parameters

o	output stream
v	target

Returns: output stream

Requirements

Header: async_mqtt/packet/property_id.hpp
Convenience header: async_mqtt/all.hpp

◆ operator<<() [2/2]

template<typename Property >

std::enable_if_t< Property::of_==detail::ostream_format::direct, std::ostream & > async_mqtt::property::operator<<	(	std::ostream &	o,
		Property const &	v )

stream output operator

Parameters

o	output stream
v	target

Returns: output stream

Requirements

Header: async_mqtt/packet/property.hpp
Convenience header: async_mqtt/all.hpp

Topics

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ properties

Requirements

◆ receive_maximum_type

Requirements

◆ session_expiry_interval_type

Requirements

◆ topic_alias_type

Requirements

Enumeration Type Documentation

◆ id

Requirements

◆ payload_format

Requirements

Function Documentation

◆ id_to_str()

Requirements

◆ operator<<() [1/2]

Requirements

◆ operator<<() [2/2]

Requirements