RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

sock: sock_*_recv_buf: mark as experimental

Browse Source
This commit is contained in:
Martine S. Lenders 2020-04-01 12:21:27 +02:00
parent f9e17ac025
commit 58685af8a6
No known key found for this signature in database
GPG Key ID: CCD317364F63286F
3 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -626,6 +626,10 @@ ssize_t sock_dtls_recv(sock_dtls_t *sock, sock_dtls_session_t *remote,
* May be SOCK_NO_TIMEOUT to wait until data
* is available.
*
* @experimental This function is quite new, not implemented for all stacks
* yet, and may be subject to sudden API changes. Do not use in
* production if this is unacceptable.
*
* @note Function may block if data is not available and @p timeout != 0
*
* @note Function blocks if no packet is currently waiting.

4
sys/include/net/sock/ip.h
View File

@ -448,6 +448,10 @@ ssize_t sock_ip_recv(sock_ip_t *sock, void *data, size_t max_len,
* @param[out] remote Remote end point of the received data.
* May be NULL, if it is not required by the application.
*
* @experimental This function is quite new, not implemented for all stacks
* yet, and may be subject to sudden API changes. Do not use in
* production if this is unacceptable.
*
* @note Function blocks if no packet is currently waiting.
*
* @return The number of bytes received on success. May not be the complete

4
sys/include/net/sock/udp.h
View File

@ -435,6 +435,10 @@ ssize_t sock_udp_recv(sock_udp_t *sock, void *data, size_t max_len,
* @param[out] remote Remote end point of the received data.
* May be `NULL`, if it is not required by the application.
*
* @experimental This function is quite new, not implemented for all stacks
* yet, and may be subject to sudden API changes. Do not use in
* production if this is unacceptable.
*
* @note Function blocks if no packet is currently waiting.
*
* @return The number of bytes received on success. May not be the complete