From 58685af8a69914164c59a177dcfd22a43acb900e Mon Sep 17 00:00:00 2001 From: "Martine S. Lenders" Date: Wed, 1 Apr 2020 12:21:27 +0200 Subject: [PATCH] sock: sock_*_recv_buf: mark as experimental --- sys/include/net/sock/dtls.h | 4 ++++ sys/include/net/sock/ip.h | 4 ++++ sys/include/net/sock/udp.h | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/sys/include/net/sock/dtls.h b/sys/include/net/sock/dtls.h index 8ed6e50d21..96569723fc 100644 --- a/sys/include/net/sock/dtls.h +++ b/sys/include/net/sock/dtls.h @@ -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. diff --git a/sys/include/net/sock/ip.h b/sys/include/net/sock/ip.h index 0b3deb9bdc..00c37c9ba8 100644 --- a/sys/include/net/sock/ip.h +++ b/sys/include/net/sock/ip.h @@ -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 diff --git a/sys/include/net/sock/udp.h b/sys/include/net/sock/udp.h index 1fe7124c03..b3c1cbf1f2 100644 --- a/sys/include/net/sock/udp.h +++ b/sys/include/net/sock/udp.h @@ -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