FreeRTOS_sockets.h
BaseType_t FreeRTOS_closesocket( Socket_t xSocket );
Close a socket.
The function is named FreeRTOS_closesocket() rather than simply
FreeRTOS_close() to avoid potential name space collisions with functions
in FreeRTOS-Plus-IO.
A socket should be shutdown
gracefully before it is closed, and cannot
be used after it has been closed.
Parameters:
xSocket
|
The handle of the socket being closed. The socket
must have already been created (see
FreeRTOS_socket()),
and cannot be used after it has been closed.
|
Returns:
0 is always returned.
Although FreeRTOS-Plus-TCP does not [currently] use the return value in a meaningful
way, the return value is included in the function prototype to ensure consistency with the
expected standard Berkeley sockets API, and to ensure compatibility with
future versions of FreeRTOS-Plus-TCP.
Example usage:
#include "FreeRTOS_sockets.h"
void aFunction( void )
{
Socket_t xSocket;
xSocket = FreeRTOS_socket( FREERTOS_AF_INET4, FREERTOS_SOCK_STREAM, FREERTOS_IPPROTO_TCP );
if( xSocket != FREERTOS_INVALID_SOCKET )
{
FreeRTOS_shutdown( xSocket );
while( FreeRTOS_recv( xSocket, pcBufferToTransmit, xTotalLengthToSend, 0 ) >= 0 )
{
vTaskDelay( pdTICKS_TO_MS( 250 ) );
}
FreeRTOS_closesocket( xSocket );
}
}
Example use of the FreeRTOS_closesocket() API function
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.