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

user property More...

#include <property.hpp>

Public Member Functions

 user_property (std::string key, 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.
 
std::string key () const
 Get key.
 
std::string val () const
 Get value.
 
constexpr buffer const & key_as_buffer () const
 Get key as buffer.
 
constexpr buffer const & val_as_buffer () const
 Get value as buffer.
 

Static Public Member Functions

static constexpr std::size_t num_of_const_buffer_sequence ()
 Get number of element of const_buffer_sequence.
 

Detailed Description

user property

Thread Safety

  • Distinct objects: Safe
  • Shared objects: Unsafe

Requirements

Constructor & Destructor Documentation

◆ user_property()

async_mqtt::property::user_property::user_property ( std::string key,
std::string val )
explicit

constructor

Parameters
keykey string
valvalue string

Member Function Documentation

◆ const_buffer_sequence()

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

Add const buffer sequence into the given buffer.

Returns
A vector of const_buffer

◆ id()

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

Get property::id.

Returns
id

◆ key()

std::string async_mqtt::property::user_property::key ( ) const

Get key.

Returns
key

◆ key_as_buffer()

buffer const & async_mqtt::property::user_property::key_as_buffer ( ) const
constexpr

Get key as buffer.

Returns
key

◆ num_of_const_buffer_sequence()

static constexpr std::size_t async_mqtt::property::user_property::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::user_property::size ( ) const

Get property size.

Returns
property size

◆ val()

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

Get value.

Returns
value

◆ val_as_buffer()

buffer const & async_mqtt::property::user_property::val_as_buffer ( ) const
constexpr

Get value as buffer.

Returns
value

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