TCPIP_UDP_TxPutIsReady Function

C

uint16_t TCPIP_UDP_TxPutIsReady(UDP_SOCKET hUDP, unsigned short count); 

Returns

The number of bytes that can be written to this socket.

Description

This function returns the number of bytes that can be written to the specified UDP socket.

Remarks

The function won't increase the size of the UDP TX buffer. If this is needed use TCPIP_UDP_OptionsSet. The count variable is not used. This function is deprecated and it will be eventually removed. The function is identical to the TCPIP_UDP_PutIsReady and maintained for backward compatibility only.

Preconditions

UDP socket should have been opened with TCPIP_UDP_ServerOpen/TCPIP_UDP_ClientOpen. hUDP - valid socket

Parameters

ParametersDescription
hUDPUDP socket handle
countNumber of bytes requested