Document FD_SETSIZE limitation for mbedtls_net_{poll,recv_timeout}

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2021-02-24 19:51:23 +01:00
parent f604240b1b
commit 58ec378912

View file

@ -182,6 +182,10 @@ int mbedtls_net_accept( mbedtls_net_context *bind_ctx,
/** /**
* \brief Check and wait for the context to be ready for read/write * \brief Check and wait for the context to be ready for read/write
* *
* \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 to check * \param ctx Socket to check
* \param rw Bitflag composed of MBEDTLS_NET_POLL_READ and * \param rw Bitflag composed of MBEDTLS_NET_POLL_READ and
* MBEDTLS_NET_POLL_WRITE specifying the events * MBEDTLS_NET_POLL_WRITE specifying the events
@ -263,6 +267,10 @@ int mbedtls_net_send( void *ctx, const unsigned char *buf, size_t len );
* 'timeout' seconds. If no error occurs, the actual amount * 'timeout' seconds. If no error occurs, the actual amount
* read is returned. * 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 ctx Socket
* \param buf The buffer to write to * \param buf The buffer to write to
* \param len Maximum length of the buffer * \param len Maximum length of the buffer