|FreeRTOS+UDP was removed from the FreeRTOS kernel download from FreeRTOS V10.1.0. See the FreeRTOS+TCP stack, which can be configured for UDP only use, as an alternative.|
[FreeRTOS Embedded IP Stack API]
xSocket_t FreeRTOS_socket( BaseType_t xDomain, BaseType_t xType, BaseType_t xProtocol );
Create a UDP socket.
The function parameters are not used other than to check they contain the expected values (and only then when configASSERT() is defined in FreeRTOSConfig.h). The parameters are included in the function prototype to ensure consistency with the expected standard Berkeley sockets prototype, and for future compatibility as FreeRTOS+UDP evolves.
Must be set to FREERTOS_AF_INET.
Must be set to FREERTOS_SOCK_DGRAM.
Must be set to FREERTOS_IPPROTO_UDP.
If a socket is created successfully, then the socket handle is returned. If there is insufficient FreeRTOS heap memory available for the socket to be created then FREERTOS_INVALID_SOCKET is returned.
/* FreeRTOS+UDP sockets include */
void aFunction( void )
/* Variable to hold the created socket. */
struct freertos_sockaddr xBindAddress;
/* Create the socket. */
xSocket = FreeRTOS_socket( FREERTOS_AF_INET, FREERTOS_SOCK_DGRAM, FREERTOS_IPPROTO_UDP );
/* Check the socket was created successfully. */
if( xSocket != FREERTOS_INVALID_SOCKET )
/* The socket was created successfully and can now be used to send data
using the FreeRTOS_sendto() API function. Sending to a socket that has
not first been bound will result in the socket being automatically bound
to a port number. Use FreeRTOS_bind() to bind the socket to a
specific port number. This example binds the socket to port 9999. The
port number is specified in network byte order, so FreeRTOS_htons() is
xBindAddress.sin_port = FreeRTOS_htons( 9999 );
if( FreeRTOS_bind( xSocket, &xBindAddress, sizeof( &xBindAddress ) ) == 0 )
/* The bind was successful. */
/* There was insufficient FreeRTOS heap memory available for the socket
to be created. */
Example use of the FreeRTOS_socket() API function