mirror of
https://github.com/boostorg/mqtt5.git
synced 2025-11-07 03:11:38 +01:00
aeab5f9665
Summary: related to T12804 - fixes in publisher and receiver examples - update year to 2024 - remove extra documentation link in README - remove unnecessary copyright & license section, it is automatically generated from 00_main.qbk Reviewers: ivica Reviewed By: ivica Subscribers: miljen, iljazovic Differential Revision: https://repo.mireo.local/D27889
27 lines
711 B
Plaintext
27 lines
711 B
Plaintext
[section:is_authenticator is_authenticator concept]
|
|
|
|
A type `Authenticator` satisfies `is_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 async_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]
|