async_mqtt::pub::opts Struct Reference

MQTT PublishOptions. More...

#include <pubopts.hpp>

Public Member Functions
constexpr	opts (std::uint8_t value)
	constructor
constexpr	opts (retain value)
	constructor
constexpr	opts (dup value)
	constructor
constexpr	opts (qos value)
	constructor
constexpr opts	operator| (opts rhs) const
	Combine opts operator.
constexpr opts	operator| (retain rhs) const
	Combine opts operator.
constexpr opts	operator| (dup rhs) const
	Combine opts operator.
constexpr opts	operator| (qos rhs) const
	Combine opts operator.
constexpr opts &	operator|= (opts rhs)
	Combine opts operator.
constexpr opts &	operator|= (retain rhs)
	Combine opts operator.
constexpr opts &	operator|= (dup rhs)
	Combine opts operator.
constexpr opts &	operator|= (qos rhs)
	Combine opts operator.
constexpr retain	get_retain () const
	Get retain.
constexpr dup	get_dup () const
	Get dup.
constexpr qos	get_qos () const
	Get qos.
constexpr	operator std::uint8_t () const
	Get byte image.
constexpr bool	operator== (opts rhs) const
	equal operator
constexpr bool	operator< (opts rhs) const
	less than operator

Related Symbols
(Note that these are not member symbols.)
constexpr bool	is_dup (std::uint8_t v)
	Check fixed header is DUP.
constexpr qos	get_qos (std::uint8_t v)
	Get qos from the fixed header.
constexpr bool	is_retain (std::uint8_t v)
	Check fixed header is RETAIN.
constexpr void	set_dup (std::uint8_t &fixed_header, bool dup)
	Set DUP to the fixed header.
constexpr opts	operator| (retain lhs, dup rhs)
	Combine opts operator.
constexpr opts	operator| (retain lhs, qos rhs)
	Combine opts operator.
constexpr opts	operator| (dup lhs, retain rhs)
	Combine opts operator.
constexpr opts	operator| (dup lhs, qos rhs)
	Combine opts operator.
constexpr opts	operator| (qos lhs, retain rhs)
	Combine opts operator.
constexpr opts	operator| (qos lhs, dup rhs)
	Combine opts operator.
constexpr char const *	retain_to_str (retain v)
	stringize retain
std::ostream &	operator<< (std::ostream &o, retain v)
	output to the stream
constexpr char const *	dup_to_str (dup v)
	stringize dup
std::ostream &	operator<< (std::ostream &o, dup v)
	output to the stream

Detailed Description

MQTT PublishOptions.

Thread Safety

• Distinct objects: Safe
• Shared objects: Unsafe

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

Requirements

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

Constructor & Destructor Documentation

opts() [1/4]

async_mqtt::pub::opts::opts ( std::uint8_t value )

inlineexplicitconstexpr

constructor

Parameters

value

Byte image of the options

opts() [2/4]

async_mqtt::pub::opts::opts ( retain value )

inlineconstexpr

constructor

Parameters

value

retain

opts() [3/4]

async_mqtt::pub::opts::opts ( dup value )

inlineconstexpr

constructor

Parameters

value

dup

opts() [4/4]

async_mqtt::pub::opts::opts ( qos value )

inlineconstexpr

constructor

Parameters

value

qos

Member Function Documentation

get_dup()

dup async_mqtt::pub::opts::get_dup ( ) const

inlineconstexpr

Get dup.

Returns

dup

get_qos()

qos async_mqtt::pub::opts::get_qos ( ) const

inlineconstexpr

Get qos.

Returns

qos

get_retain()

retain async_mqtt::pub::opts::get_retain ( ) const

inlineconstexpr

Get retain.

Returns

retain

operator std::uint8_t()

async_mqtt::pub::opts::operator std::uint8_t ( ) const

inlineexplicitconstexpr

Get byte image.

Returns

byte image

operator<()

bool async_mqtt::pub::opts::operator< ( opts rhs ) const

inlineconstexpr

less than operator

Parameters

rhs	compare target

Returns

true if this less than the rhs, otherwise false.

operator==()

bool async_mqtt::pub::opts::operator== ( opts rhs ) const

inlineconstexpr

equal operator

Parameters

rhs	compare target

Returns

true if this equal to the rhs, otherwise false.

operator|() [1/4]

opts async_mqtt::pub::opts::operator| ( dup rhs ) const

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|() [2/4]

opts async_mqtt::pub::opts::operator| ( opts rhs ) const

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|() [3/4]

opts async_mqtt::pub::opts::operator| ( qos rhs ) const

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|() [4/4]

opts async_mqtt::pub::opts::operator| ( retain rhs ) const

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [1/4]

opts & async_mqtt::pub::opts::operator|= ( dup rhs )

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [2/4]

opts & async_mqtt::pub::opts::operator|= ( opts rhs )

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [3/4]

opts & async_mqtt::pub::opts::operator|= ( qos rhs )

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [4/4]

opts & async_mqtt::pub::opts::operator|= ( retain rhs )

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

Friends And Related Symbol Documentation

operator|() [1/6]

opts operator| ( dup lhs, qos rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [2/6]

opts operator| ( dup lhs, retain rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [3/6]

opts operator| ( qos lhs, dup rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [4/6]

opts operator| ( qos lhs, retain rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [5/6]

opts operator| ( retain lhs, dup rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [6/6]

opts operator| ( retain lhs, qos rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

---

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

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