async_mqtt 5.0.0
Loading...
Searching...
No Matches
async_mqtt::property::user_property Class Reference

#include <property.hpp>

Inherits boost::totally_ordered< user_property >.

Public Member Functions

 user_property (buffer key, buffer 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 buffer constkey () const
 Get key.
 
constexpr buffer constval () 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.
 

Detailed Description

@breif user property

Constructor & Destructor Documentation

◆ user_property()

async_mqtt::property::user_property::user_property ( buffer key,
buffer val )
inline

constructor

Parameters
valresponse_information string

Member Function Documentation

◆ const_buffer_sequence()

std::vector< as::const_buffer > async_mqtt::property::user_property::const_buffer_sequence ( ) const
inline

Add const buffer sequence into the given buffer.

Returns
A vector of const_buffer

◆ id()

property::id async_mqtt::property::user_property::id ( ) const
inline

Get property::id.

Returns
id

◆ key()

constexpr buffer const & async_mqtt::property::user_property::key ( ) const
inlineconstexpr

Get key.

Returns
key

◆ num_of_const_buffer_sequence()

static constexpr std::size_t async_mqtt::property::user_property::num_of_const_buffer_sequence ( )
inlinestaticconstexpr

Get number of element of const_buffer_sequence.

Returns
number of element of const_buffer_sequence

◆ size()

std::size_t async_mqtt::property::user_property::size ( ) const
inline

Get property size.

Returns
property size

◆ val()

constexpr buffer const & async_mqtt::property::user_property::val ( ) const
inlineconstexpr

Get value.

Returns
value

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