diff options
author | Tomek Mrugalski <tomasz@isc.org> | 2021-03-23 11:19:36 +0100 |
---|---|---|
committer | Francis Dupont <fdupont@isc.org> | 2021-03-24 09:10:30 +0100 |
commit | 1b102edeb1f6f64828bc8b05fb55c000e348b03d (patch) | |
tree | 3a70e73d696bb4fa947fa5dd288d74c9eed42124 /src/lib/http/client.h | |
parent | [#1661] Simplified shutdownConnection() name (diff) | |
download | kea-1b102edeb1f6f64828bc8b05fb55c000e348b03d.tar.xz kea-1b102edeb1f6f64828bc8b05fb55c000e348b03d.zip |
[#1661] Extended HandshakeHandler description
Diffstat (limited to 'src/lib/http/client.h')
-rw-r--r-- | src/lib/http/client.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/lib/http/client.h b/src/lib/http/client.h index 20ec30947e..f4eeb18eb1 100644 --- a/src/lib/http/client.h +++ b/src/lib/http/client.h @@ -104,6 +104,11 @@ public: /// @brief Optional handler invoked when client performs the TLS handshake /// with the server. /// + /// It is called when the TLS handshake completes: + /// - if the handshake succeeds it is called with error code 0 + /// - if the handshake fails it is called with error code != 0 + /// - if TLS is not enabled, it is not called at all + /// /// Returned boolean value indicates whether the client should continue /// connecting to the server (if true) or not (false). /// @note The second argument is not used. |