boostorg/mqtt5
1
0
Fork 1
mirror of https://github.com/boostorg/mqtt5.git synced 2025-10-04 12:50:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

[mqtt-client] reason codes & properties documented

Browse Source 
Summary: related to T12804

Reviewers: ivica

Reviewed By: ivica

Subscribers: miljen

Differential Revision: https://repo.mireo.local/D26113
This commit is contained in:
Korina Šimičević
2023-10-16 15:57:26 +02:00
parent 296e28da93
commit 22f1330fed
15 changed files with 497 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
include/async_mqtt5/mqtt_client.hpp
View File

@@ -126,7 +126,8 @@ public:
/**
* \brief Cancel all asynchronous operations.
*
* \details All outstanding operations will complete with `boost::asio::error::operation_aborted`.
* \details All outstanding operations will complete
* with `boost::asio::error::operation_aborted`.
*/
void cancel() {
get_executor().execute([svc_ptr = _svc_ptr]() {
@@ -137,7 +138,9 @@ public:
/**
* \brief Assign a \ref will Message.
*
* \details The \ref will Message that will be published after the Network Connection is closed.
* \details The \ref will Message that the Broker should publish
* after the Network Connection is closed and it is not
* closed normally.
*/
mqtt_client& will(will will) {
_svc_ptr->will(std::move(will));
@@ -324,7 +327,7 @@ public:
* to Topics that the Client subscribed to. The PUBLISH packets can be received
* with \ref mqtt_client::async_receive function.
*
* \param topic \ref subscribe_topic of interest.
* \param topic A \ref subscribe_topic of interest.
* \param props SUBSCRIBE properties.
* \param token Completion token that will be used to produce a
* completion handler, which will be called when the operation completed.
@@ -519,7 +522,8 @@ public:
* \par Error codes
* The list of all possible error codes that this operation can finish with:\n
* - `boost::system::errc::errc_t::success`\n
* - `boost::asio::error::try_again` -- why?
* - `boost::asio::operation_aborted`\n
* - `boost::asio::no_recovery`\n
*/
template <typename CompletionToken>
decltype(auto) async_disconnect(
@@ -555,7 +559,8 @@ public:
* \par Error codes
* The list of all possible error codes that this operation can finish with:\n
* - `boost::system::errc::errc_t::success`\n
* - `boost::asio::error::try_again` -- why?
* - `boost::asio::operation_aborted`\n
* - `boost::asio::no_recovery`\n
*/
template <typename CompletionToken>
decltype(auto) async_disconnect(CompletionToken&& token) {