async_mqtt::sub::opts Struct Reference

MQTT SubscribeOptions. More...

#include <subopts.hpp>

Public Member Functions
constexpr	opts (std::uint8_t value)
	constructor
constexpr	opts (retain_handling value)
	constructor
constexpr	opts (rap value)
	constructor
constexpr	opts (nl value)
	constructor
constexpr	opts (qos value)
	constructor
constexpr opts	operator| (opts rhs) const
	Combine opts operator.
constexpr opts	operator| (retain_handling rhs) const
	Combine opts operator.
constexpr opts	operator| (rap rhs) const
	Combine opts operator.
constexpr opts	operator| (nl 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_handling rhs)
	Combine opts operator.
constexpr opts &	operator|= (rap rhs)
	Combine opts operator.
constexpr opts &	operator|= (nl rhs)
	Combine opts operator.
constexpr opts &	operator|= (qos rhs)
	Combine opts operator.
constexpr retain_handling	get_retain_handling () const
	Get retain_handling.
constexpr rap	get_rap () const
	Get rap.
constexpr nl	get_nl () const
	Get nl.
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 opts	operator| (retain_handling lhs, rap rhs)
	Combine opts operator.
constexpr opts	operator| (retain_handling lhs, nl rhs)
	Combine opts operator.
constexpr opts	operator| (retain_handling lhs, qos rhs)
	Combine opts operator.
constexpr opts	operator| (rap lhs, retain_handling rhs)
	Combine opts operator.
constexpr opts	operator| (rap lhs, nl rhs)
	Combine opts operator.
constexpr opts	operator| (rap lhs, qos rhs)
	Combine opts operator.
constexpr opts	operator| (nl lhs, retain_handling rhs)
	Combine opts operator.
constexpr opts	operator| (nl lhs, rap rhs)
	Combine opts operator.
constexpr opts	operator| (nl lhs, qos rhs)
	Combine opts operator.
constexpr opts	operator| (qos lhs, retain_handling rhs)
	Combine opts operator.
constexpr opts	operator| (qos lhs, rap rhs)
	Combine opts operator.
constexpr opts	operator| (qos lhs, nl rhs)
	Combine opts operator.
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

MQTT SubscribeOptions.

Thread Safety

• Distinct objects: Safe
• Shared objects: Unsafe

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

Constructor & Destructor Documentation

opts() [1/5]

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

inlineexplicitconstexpr

constructor

Parameters

value

Byte image of the options

opts() [2/5]

async_mqtt::sub::opts::opts ( retain_handling value )

inlineconstexpr

constructor

Parameters

value

retain_handling

opts() [3/5]

async_mqtt::sub::opts::opts ( rap value )

inlineconstexpr

constructor

Parameters

value

rap

opts() [4/5]

async_mqtt::sub::opts::opts ( nl value )

inlineconstexpr

constructor

Parameters

value

nl

opts() [5/5]

async_mqtt::sub::opts::opts ( qos value )

inlineconstexpr

constructor

Parameters

value

qos

Member Function Documentation

get_nl()

nl async_mqtt::sub::opts::get_nl ( ) const

inlineconstexpr

Get nl.

Returns

no

get_qos()

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

inlineconstexpr

Get qos.

Returns

qos

get_rap()

rap async_mqtt::sub::opts::get_rap ( ) const

inlineconstexpr

Get rap.

Returns

rap

get_retain_handling()

retain_handling async_mqtt::sub::opts::get_retain_handling ( ) const

inlineconstexpr

Get retain_handling.

Returns

retain_handling

operator std::uint8_t()

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

inlineexplicitconstexpr

Get byte image.

Returns

byte image

operator<()

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

inlineconstexpr

less than operator

Parameters

rhs	compare target

Returns

true if this opts less than the rhs, otherwise false.

operator==()

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

inlineconstexpr

equal operator

Parameters

rhs	compare target

Returns

true if this opts equal to the rhs, otherwise false.

operator|() [1/5]

opts async_mqtt::sub::opts::operator| ( nl rhs ) const

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|() [2/5]

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

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|() [3/5]

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

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|() [4/5]

opts async_mqtt::sub::opts::operator| ( rap rhs ) const

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|() [5/5]

opts async_mqtt::sub::opts::operator| ( retain_handling rhs ) const

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [1/5]

opts & async_mqtt::sub::opts::operator|= ( nl rhs )

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [2/5]

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

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [3/5]

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

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [4/5]

opts & async_mqtt::sub::opts::operator|= ( rap rhs )

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

operator|=() [5/5]

opts & async_mqtt::sub::opts::operator|= ( retain_handling rhs )

inlineconstexpr

Combine opts operator.

Parameters

rhs	combined target

Returns

conbined opts

Friends And Related Symbol Documentation

operator|() [1/12]

opts operator| ( nl lhs, qos rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [2/12]

opts operator| ( nl lhs, rap rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [3/12]

opts operator| ( nl lhs, retain_handling rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [4/12]

opts operator| ( qos lhs, nl rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [5/12]

opts operator| ( qos lhs, rap rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [6/12]

opts operator| ( qos lhs, retain_handling rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [7/12]

opts operator| ( rap lhs, nl rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [8/12]

opts operator| ( rap lhs, qos rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [9/12]

opts operator| ( rap lhs, retain_handling rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [10/12]

opts operator| ( retain_handling lhs, nl rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [11/12]

opts operator| ( retain_handling lhs, qos rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

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

operator|() [12/12]

opts operator| ( retain_handling lhs, rap rhs )

related

Combine opts operator.

Parameters

lhs	combined target
rhs	combined target

Returns

conbined opts

Requirements

• Header: async_mqtt/packet/subopts.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/subopts.hpp