mirror of
https://github.com/boostorg/mqtt5.git
synced 2026-01-27 01:22:21 +01:00
1fe10dd6a3
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
32 lines
977 B
Plaintext
32 lines
977 B
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:Authenticator Authenticator concept]
|
|
|
|
A type `T` satisfies `Authenticator` concept if it satisifes the requirements listed below.
|
|
|
|
[table
|
|
[[operation] [type] [arguments]]
|
|
[
|
|
[```a.async_auth(step, data, h)```]
|
|
[`void`]
|
|
[
|
|
[*`step`] is [reflink2 auth_step_e boost::mqtt5::auth_step_e] that specifies current authentication stage.
|
|
|
|
[*`data`] is `std::string`, server's authentication data.
|
|
|
|
[*`h`] is [asioreflink any_completion_handler any_completion_handler] with signature `void(__ERROR_CODE__ ec, std::string client_data)`. If `ec` is non-trivial, authentication is aborted.
|
|
]
|
|
]
|
|
[
|
|
[```a.method()```]
|
|
[`std::string_view`, authentication method]
|
|
[]
|
|
]
|
|
]
|
|
|
|
[endsect]
|