forked from boostorg/mqtt5
Korina Šimičević
40ad372736
Summary: related to T15996 updates copyright year to 2025 Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D33759
57 lines
2.6 KiB
Plaintext
57 lines
2.6 KiB
Plaintext
[/
|
|
Copyright (c) 2023-2025 Ivica Siladic, Bruno Iljazovic, Korina Simicevic
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
]
|
|
|
|
[section:auth_props AUTH properties]
|
|
The last field in the Variable header of __AUTH__ packet is a set of Properties.
|
|
A set contains a Property Length followed by the Properties.
|
|
A Property consists of an Identifier and a value.
|
|
|
|
This section lists all possible __AUTH__ Properties and describes their usage:
|
|
|
|
[table:auth_props AUTH properties
|
|
[[Identifier] [Value type] [Description]]
|
|
[[authentication_method] [`std::string`] [A UTF-8 Encoded String containing the name of the authentication method used for extended authentication.]]
|
|
[[authentication_data] [`std::string`] [Binary Data containing authentication data. The contents of the data are defined by the authentication method.]]
|
|
[[reason_string] [`std::string`] [A UTF-8 Encoded String representing the reason associated with this response.]]
|
|
[[user_property] [`std::pair<std::string, std::string>`] [Name, value pair (__UTF8_STRING_PAIR__) defining User Property. There can be multiple pairs in one packet.
|
|
This property may be used to provide additional diagnostic or other information. ]]
|
|
]
|
|
|
|
[h4 Usage]
|
|
After obtaining an instance of `boost::mqtt5::auth_props`, the subscript operator can be used to access a Property.
|
|
|
|
The Identifiers listed in the table above are available within the `boost::mqtt5::prop` namespace for Property access.
|
|
|
|
[note When accessing a property value, the subscript operator will return a `std::optional` of the value type for all properties,
|
|
except for `boost::mqtt5::prop::user_property`, where it will return an instance of `std::vector<std::pair<std::string, std::string>>`.]
|
|
|
|
[h4 Example]
|
|
|
|
The following example shows how to set a Property value:
|
|
|
|
[!c++]
|
|
boost::mqtt5::auth_props props;
|
|
props[boost::mqtt5::prop::authentication_method] = "SCRAM-SHA-1";
|
|
props[boost::mqtt5::prop::authentication_data] = "data";
|
|
props[boost::mqtt5::prop::user_property].emplace_back("name", "value");
|
|
|
|
The following example shows how to retrieve a Property value:
|
|
|
|
[!c++]
|
|
std::optional<std::string> auth_data = props[boost::mqtt5::prop::authentication_data];
|
|
if (auth_data.has_value())
|
|
// authentication data property was previously set
|
|
else
|
|
// authentication data property was not set
|
|
|
|
std::vector<std::pair<std::string, std::string>>& user_props = props[boost::mqtt5::prop::user_property];
|
|
if (!user_props.empty())
|
|
// user property was previously set
|
|
else
|
|
// user property was not set
|
|
|
|
[endsect]
|