mirror of
https://github.com/boostorg/mqtt5.git
synced 2025-11-02 17:01:44 +01:00
Doc fixes
Summary: related to T15258, T15261 - improved TlsContext documentation - hide `detail::is_authenticator` explicitly from docs - remove ExecutionContext from concepts, now it just links to asio docs - fix user_property and subscription_identifier value type in property docs Reviewers: ivica Reviewed By: ivica Subscribers: iljazovic, miljen Differential Revision: https://repo.mireo.local/D33857
This commit is contained in:
@@ -131,15 +131,13 @@ public:
|
||||
|
||||
/**
|
||||
* \brief Move-construct an mqtt_client from another.
|
||||
*
|
||||
* \details Moved-from client can only be destructed
|
||||
*/
|
||||
mqtt_client(mqtt_client&&) noexcept = default;
|
||||
|
||||
/**
|
||||
* \brief Move assignment operator.
|
||||
*
|
||||
* \details Cancels this client first. Moved-from client can only be destructed.
|
||||
* \details Cancels this client first.
|
||||
*/
|
||||
mqtt_client& operator=(mqtt_client&& other) noexcept {
|
||||
_impl->cancel();
|
||||
@@ -313,7 +311,7 @@ public:
|
||||
* Re-authentication can be initiated by calling \ref re_authenticate.
|
||||
*
|
||||
* \param authenticator Object that will be stored (move-constructed or by reference)
|
||||
* and used for authentication. It needs to satisfy \__is_authenticator\__ concept.
|
||||
* and used for authentication. It needs to satisfy \__Authenticator\__ concept.
|
||||
*
|
||||
* \attention This function takes action when the client is in a non-operational state,
|
||||
* meaning the \ref async_run function has not been invoked.
|
||||
@@ -321,11 +319,12 @@ public:
|
||||
* before the \ref async_run function is invoked again.
|
||||
*
|
||||
*/
|
||||
template <
|
||||
typename Authenticator,
|
||||
std::enable_if_t<detail::is_authenticator<Authenticator>, bool> = true
|
||||
>
|
||||
template <typename Authenticator>
|
||||
mqtt_client& authenticator(Authenticator&& authenticator) {
|
||||
static_assert(
|
||||
detail::is_authenticator<Authenticator>,
|
||||
"The type does not satisfy the Authenticator concept"
|
||||
);
|
||||
_impl->authenticator(std::forward<Authenticator>(authenticator));
|
||||
return *this;
|
||||
}
|
||||
|
||||
@@ -81,12 +81,12 @@ enum class auth_step_e {
|
||||
/** \brief The Client needs to send initial authentication data. */
|
||||
client_initial,
|
||||
|
||||
/** \brief Server responded with reason_codes.continue_authentication and possibly
|
||||
/** \brief Server responded with \ref reason_codes::continue_authentication and possibly
|
||||
* authentication data, the Client needs to send further authentication data.
|
||||
*/
|
||||
server_challenge,
|
||||
|
||||
/** \brief Server responded with reason_codes.success and final
|
||||
/** \brief Server responded with \ref reason_codes::success and final
|
||||
* authentication data, which the Client validates.
|
||||
*/
|
||||
server_final
|
||||
|
||||
Reference in New Issue
Block a user