riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

sock/dtls: add example of a blocking handshake to the doc

Browse Source
This commit is contained in:
János Brodbeck 2021-01-04 20:21:22 +01:00
parent 34a15b6540
commit a72e053d32
No known key found for this signature in database
GPG Key ID: 65C193B0D8D1BCE6
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
sys/include/net/sock/dtls.h
View File

@ -907,6 +907,14 @@ ssize_t sock_dtls_send_aux(sock_dtls_t *sock, sock_dtls_session_t *remote,
* @note When blocking, we will need an extra thread to call * @note When blocking, we will need an extra thread to call
* @ref sock_dtls_recv() function to handle the incoming handshake * @ref sock_dtls_recv() function to handle the incoming handshake
* messages. * messages.
* An example for a blocking handshake is:
* 1. Create an empty @ref sock_dtls_session_t object.
* 2. Set the UDP endpoint of the peer you want to connect to in the
* session object with @ref sock_dtls_session_set_udp_ep().
* 3. Call @ref sock_dtls_send() with a timeout greater than 0.
* The send function blocks until the handshake completes or the
* timeout expires. If the handshake was successful the data has
* been sent.
* *
* @return The number of bytes sent on success * @return The number of bytes sent on success
* @return -ENOTCONN, if `timeout == 0` and no existing session exists with * @return -ENOTCONN, if `timeout == 0` and no existing session exists with