luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Sync GDtlsConnection handshake docs with GTlsConnection

Browse Source 
Sadly, I forgot to update the documentation of
g_dtls_connection_handshake() last time I touched
g_tls_connection_handshake().

Let's also drop mention of STARTTLS, since that would use normal TLS,
not DTLS.
This commit is contained in:
Michael Catanzaro 2020-01-02 20:24:30 -06:00
parent 7ff3875591
commit 85c19a7977
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
gio/gdtlsconnection.c
View File

@ -691,15 +691,15 @@ G_GNUC_END_IGNORE_DEPRECATIONS
*
* On the client side, it is never necessary to call this method;
* although the connection needs to perform a handshake after
* connecting (or after sending a "STARTTLS"-type command) and may
* need to rehandshake later if the server requests it,
* #GDtlsConnection will handle this for you automatically when you try
* to send or receive data on the connection. However, you can call
* g_dtls_connection_handshake() manually if you want to know for sure
* whether the initial handshake succeeded or failed (as opposed to
* just immediately trying to write to @conn, in which
* case if it fails, it may not be possible to tell if it failed
* before or after completing the handshake).
* connecting, #GDtlsConnection will handle this for you automatically
* when you try to send or receive data on the connection. You can call
* g_dtls_connection_handshake() manually if you want to know whether
* the initial handshake succeeded or failed (as opposed to just
* immediately trying to use @conn to read or write, in which case,
* if it fails, it may not be possible to tell if it failed before
* or after completing the handshake), but beware that servers may reject
* client authentication after the handshake has completed, so a
* successful handshake does not indicate the connection will be usable.
*
* Likewise, on the server side, although a handshake is necessary at
* the beginning of the communication, you do not need to call this