net/emcute: added doc for maximum buffer size

On 16- and 8-bit platforms, ssizte_t can only hold 2 byte (maximum
of 32767). So when calling sock_udp_recv() we can not pass it a
buffer exeeding this size without potially running into overflow
This commit is contained in:
Hauke Petersen 2017-06-28 10:17:25 +02:00
parent 91ff52a897
commit 9ec615f8c2
1 changed files with 3 additions and 0 deletions

View File

@ -106,6 +106,9 @@ extern "C" {
* @brief Buffer size used for emCute's transmit and receive buffers
* @note The buffer size MUST be less than 32768 on 16-bit and 8-bit
* platforms to prevent buffer overflows.
* The overall buffer size used by emCute is this value time two (Rx + Tx).
#define EMCUTE_BUFSIZE (512U)