async_mqtt::property::authentication_data Class Reference

authentication_data property More...

#include <property.hpp>

Public Member Functions
	authentication_data (std::string val)
	constructor
std::vector< as::const_buffer >	const_buffer_sequence () const
	Add const buffer sequence into the given buffer.
property::id	id () const
	Get property::id.
std::size_t	size () const
	Get property size.
constexpr std::string	val () const
	Get value.
constexpr buffer const &	val_as_buffer () const
	Get value.

Static Public Member Functions
static constexpr std::size_t	num_of_const_buffer_sequence ()
	Get number of element of const_buffer_sequence.

Friends
bool	operator< (binary_property const &lhs, binary_property const &rhs)
	less than operator
bool	operator== (binary_property const &lhs, binary_property const &rhs)
	equal operator

Detailed Description

authentication_data property

Thread Safety

• Distinct objects: Safe
• Shared objects: Unsafe

Requirements

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

Constructor & Destructor Documentation

authentication_data()

async_mqtt::property::authentication_data::authentication_data ( std::string val )

explicit

constructor

Parameters

val	authentication_data string

Member Function Documentation

const_buffer_sequence()

std::vector< as::const_buffer > async_mqtt::property::authentication_data::const_buffer_sequence

(

)

const

Add const buffer sequence into the given buffer.

Returns

A vector of const_buffer

id()

property::id async_mqtt::property::authentication_data::id

(

)

const

Get property::id.

Returns

id

num_of_const_buffer_sequence()

static constexpr std::size_t async_mqtt::property::authentication_data::num_of_const_buffer_sequence ( )

staticconstexpr

Get number of element of const_buffer_sequence.

Returns

number of element of const_buffer_sequence

size()

std::size_t async_mqtt::property::authentication_data::size

(

)

const

Get property size.

Returns

property size

val()

std::string async_mqtt::property::authentication_data::val ( ) const

constexpr

Get value.

Returns

value

val_as_buffer()

buffer const & async_mqtt::property::authentication_data::val_as_buffer ( ) const

constexpr

Get value.

Returns

value

Friends And Related Symbol Documentation

operator<

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

friend

less than operator

Parameters

lhs	compare target
rhs	compare target

Returns

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

operator==

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

friend

equal operator

Parameters

lhs	compare target
rhs	compare target

Returns

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

---

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

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