async_mqtt::v5::connack_packet Class Reference

MQTT CONNACK packet (v5) More...

#include <v5_connack.hpp>

Public Member Functions
	connack_packet (bool session_present, connect_reason_code reason_code, properties props={})
	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.
bool	session_present () const
	Get session present.
connect_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.

Related Symbols
(Note that these are not member symbols.)
bool	operator< (connack_packet const &lhs, connack_packet const &rhs)
	less than operator
bool	operator== (connack_packet const &lhs, connack_packet const &rhs)
	equal operator
std::ostream &	operator<< (std::ostream &o, connack_packet const &v)
	stream output operator

Detailed Description

MQTT CONNACK packet (v5)

Only MQTT broker(sever) can send this packet.
See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901074

Thread Safety

• Distinct objects: Safe
• Shared objects: Unsafe

Requirements

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

Constructor & Destructor Documentation

connack_packet()

async_mqtt::v5::connack_packet::connack_packet ( bool session_present, connect_reason_code reason_code, properties props = {} )

explicit

constructor

Parameters

session_present	If the broker stores the session, then true, otherwise false. When the endpoint receives CONNACK packet with session_present is false, then stored packets are erased.
reason_code	ConnectReasonCode See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901079
props	properties. See https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901080

Member Function Documentation

code()

connect_reason_code async_mqtt::v5::connack_packet::code

(

)

const

Get reason code.

Returns

reason_code

const_buffer_sequence()

std::vector< as::const_buffer > async_mqtt::v5::connack_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::connack_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::connack_packet::props

(

)

const

Get properties.

Returns

properties

session_present()

bool async_mqtt::v5::connack_packet::session_present

(

)

const

Get session present.

Returns

true if the session is present, otherwise false

size()

std::size_t async_mqtt::v5::connack_packet::size

(

)

const

Get packet size.

Returns

packet size

type()

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

inlinestaticconstexpr

Get MQTT control packet type.

Returns

control packet type

Friends And Related Symbol Documentation

operator<()

bool operator< ( connack_packet const & lhs, connack_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_connack.hpp
• Convenience header: async_mqtt/all.hpp

operator<<()

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

related

stream output operator

Parameters

o	output stream
v	target

Returns

output stream

Requirements

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

operator==()

bool operator== ( connack_packet const & lhs, connack_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_connack.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_connack.hpp