async_mqtt::v5::auth_packet Class Reference

MQTT AUTH packet (v5) More...

#include <v5_auth.hpp>

Public Member Functions
	auth_packet (auth_reason_code reason_code, properties props)
	constructor
	auth_packet ()
	constructor
	auth_packet (auth_reason_code reason_code)
	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.
auth_reason_code	code () const
	Get reason code.
properties const &	props () const
	Get properties.

Static Public Member Functions
static constexpr control_packet_type	type ()
	Get MQTT control packet type.

Friends
std::ostream &	operator<< (std::ostream &o, auth_packet const &v)
	stream output operator

Related Symbols
(Note that these are not member symbols.)
bool	operator< (auth_packet const &lhs, auth_packet const &rhs)
	less than operator
bool	operator== (auth_packet const &lhs, auth_packet const &rhs)
	equal operator

Detailed Description

MQTT AUTH packet (v5)

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

Thread Safety

• Distinct objects: Safe
• Shared objects: Unsafe

Requirements

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

Constructor & Destructor Documentation

auth_packet() [1/2]

async_mqtt::v5::auth_packet::auth_packet ( auth_reason_code reason_code, properties props )

explicit

constructor

Parameters

reason_code	auth_reason_code See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901220
props	properties See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901221

auth_packet() [2/2]

async_mqtt::v5::auth_packet::auth_packet ( auth_reason_code reason_code )

explicit

constructor

Parameters

reason_code

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

Member Function Documentation

code()

auth_reason_code async_mqtt::v5::auth_packet::code

(

)

const

Get reason code.

Returns

reason_code

const_buffer_sequence()

std::vector< as::const_buffer > async_mqtt::v5::auth_packet::const_buffer_sequence

(

)

const

Create const buffer sequence it is for boost asio APIs.

Returns

const buffer sequence

num_of_const_buffer_sequence()

std::size_t async_mqtt::v5::auth_packet::num_of_const_buffer_sequence

(

)

const

Get number of element of const_buffer_sequence.

Returns

number of element of const_buffer_sequence

props()

properties const & async_mqtt::v5::auth_packet::props

(

)

const

Get properties.

Returns

properties

size()

std::size_t async_mqtt::v5::auth_packet::size

(

)

const

Get packet size.

Returns

packet size

type()

static constexpr control_packet_type async_mqtt::v5::auth_packet::type ( )

inlinestaticconstexpr

Get MQTT control packet type.

Returns

control packet type

Friends And Related Symbol Documentation

operator<()

bool operator< ( auth_packet const & lhs, auth_packet const & rhs )

related

less than operator

Parameters

lhs	compare target
rhs	compare target

Returns

true if the lhs less than the rhs, otherwise false.

Requirements

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

operator<<

std::ostream & operator<< ( std::ostream & o, auth_packet const & v )

friend

stream output operator

Parameters

o	output stream
v	target

Returns

output stream

operator==()

bool operator== ( auth_packet const & lhs, auth_packet const & rhs )

related

equal operator

Parameters

lhs	compare target
rhs	compare target

Returns

true if the lhs equal to the rhs, otherwise false.

Requirements

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

---

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

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