Skip to content

Commit 5ea1ee3

Browse files
committed
sys/net/sock_dtls: document SOCK_DTLS_HANDSHAKE in user guide
1 parent 403a4d0 commit 5ea1ee3

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

sys/include/net/sock/dtls.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,8 +284,9 @@
284284
* application waits indefinitely for new packets. If we want to timeout this
285285
* wait period we could alternatively set the `timeout` parameter of the
286286
* function to a value != @ref SOCK_NO_TIMEOUT. If an error occurs we just
287-
* ignore it and continue looping. We can reply to an incoming message using
288-
* its `session`.
287+
* ignore it and continue looping. A newly established DTLS session would be
288+
* signaled by a return value @ref -SOCK_DTLS_HANDSHAKE, but it is also ignored
289+
* here. We can reply to an incoming message using its `session`.
289290
*
290291
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.c}
291292
* while (1) {

0 commit comments

Comments
 (0)