@CHIP-RTOS C Library - TCP/IP API

GetWaitingBytes

Report the number of bytes available on a socket, waiting to be read.

int GetWaitingBytes ( int sd, int *error );

Parameters

sd

Socket descriptor.

error

Output parameter:  Failure code, 0 on success.

Return Value

-1 on failure, see error reported
else count of received bytes waiting on socket.

Comments

If the specified socket is an UDP socket, GetWaitingBytes() will return the size (in bytes) of the next waiting datagram at the internal socket receive queue.

See Also

recv        recvfrom        opensocket

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00