commit 51917a82e83104ddfd58b8363e85f01d81d836b3
author Gilles Peskine <Gilles.Peskine@arm.com> Wed Feb 24 19:51:23 2021 +0100
committer Gilles Peskine <Gilles.Peskine@arm.com> Wed Mar 03 12:23:27 2021 +0100
tree 38c44d7f3e5343ea67ffc36d6ca22763c402bcc5
parent 33d816aff99020b57b54961df60ca0e843a1178f

Document FD_SETSIZE limitation for mbedtls_net_recv_timeout

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>

include/mbedtls/net_sockets.h

diff --git a/include/mbedtls/net_sockets.h b/include/mbedtls/net_sockets.h
index 0d61547..67fe1e9 100644
--- a/include/mbedtls/net_sockets.h
+++ b/include/mbedtls/net_sockets.h
@@ -219,6 +219,10 @@
  *                 'timeout' seconds. If no error occurs, the actual amount
  *                 read is returned.
  *
+ * \note           The current implementation of this function uses
+ *                 select() and returns an error if the file descriptor
+ *                 is beyond \c FD_SETSIZE.
+ *
  * \param ctx      Socket
  * \param buf      The buffer to write to
  * \param len      Maximum length of the buffer