SUBSCRIBE packet flags

Collaboration diagram for SUBSCRIBE packet flags:

Classes
struct	async_mqtt::sub::opts
	MQTT SubscribeOptions. More...

Enumerations
enum class	async_mqtt::sub::retain_handling : std::uint8_t { retain_handling::send = 0b00000000 , retain_handling::send_only_new_subscription = 0b00010000 , retain_handling::not_send = 0b00100000 }
	MQTT RetainHandling. More...
enum class	async_mqtt::sub::rap : std::uint8_t { rap::dont = 0b00000000 , rap::retain = 0b00001000 }
	MQTT RetainAsPublished. More...
enum class	async_mqtt::sub::nl : std::uint8_t { nl::no = 0b00000000 , nl::yes = 0b00000100 }
	MQTT NoLocal. More...

Functions
constexpr char const *	retain_handling_to_str (retain_handling v)
	stringize retain_handling
std::ostream &	operator<< (std::ostream &o, retain_handling v)
	output to the stream
constexpr char const *	rap_to_str (rap v)
	stringize rap(retain as published)
std::ostream &	operator<< (std::ostream &o, rap v)
	output to the stream
constexpr char const *	nl_to_str (nl v)
	stringize nl(no local)
std::ostream &	operator<< (std::ostream &o, nl v)
	output to the stream

Detailed Description

Enumeration Type Documentation

nl

enum class async_mqtt::sub::nl : std::uint8_t

strong

MQTT NoLocal.

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

Requirements

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

Enumerator
no	Subscriber's publish would be delivered to the subscriber itself. Same as MQTT v.3.1.1.
yes	Subscriber's publish would not be delivered to the subscriber itself.

rap

enum class async_mqtt::sub::rap : std::uint8_t

strong

MQTT RetainAsPublished.

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

Requirements

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

Enumerator
dont	Retain is set to 0 delivery on publish by the broker. Same as MQTT v.3.1.1.
retain	Preserve published Retain delivery on publish by the broker.

retain_handling

enum class async_mqtt::sub::retain_handling : std::uint8_t

strong

MQTT RetainHandling.

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

Requirements

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

Enumerator
send	Always send. Same as MQTT v.3.1.1.
send_only_new_subscription	Only new subscription. Not overwrite.
not_send	Always not send.

Function Documentation

nl_to_str()

char const * nl_to_str ( nl v )

related

stringize nl(no local)

Parameters

v

target

Returns

nl(no local) string

Requirements

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

operator<<() [1/3]

std::ostream & operator<< ( std::ostream & o, nl v )

related

output to the stream

Parameters

o	output stream
v	target

Returns

output stream

Requirements

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

operator<<() [2/3]

std::ostream & operator<< ( std::ostream & o, rap v )

related

output to the stream

Parameters

o	output stream
v	target

Returns

output stream

Requirements

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

operator<<() [3/3]

std::ostream & operator<< ( std::ostream & o, retain_handling v )

related

output to the stream

Parameters

o	output stream
v	target

Returns

output stream

Requirements

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

rap_to_str()

char const * rap_to_str ( rap v )

related

stringize rap(retain as published)

Parameters

v

target

Returns

rap(retain as published) string

Requirements

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

retain_handling_to_str()

char const * retain_handling_to_str ( retain_handling v )

related

stringize retain_handling

Parameters

v

target

Returns

retain_handling string

Requirements

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