FreeRTOS_recvcount()

[FreeRTOS+TCP API Reference]

FreeRTOS_sockets.h

BaseType_t FreeRTOS_recvcount( Socket_t xSocket );
		

Returns the number of bytes in a TCP socket's Rx stream that are yet to be read.

Parameters:

xSocket

The socket being queried.

Returns:

If the socket referenced by the xSocket parameter is not a TCP socket then -pdFREERTOS_ERRNO_EINVAL is returned.

If the socket referenced by the xSocket parameter does not yet have an Rx stream then 0 is returned (the Rx stream is not created until it is required).

In all other cases the returned value is the number of bytes that remain in the socket's Rx stream.