BaseType_t FreeRTOS_shutdown( Socket_t xSocket, BaseType_t xHow );
Disable reads and writes on a connected TCP socket.
A connected TCP socket must be gracefully shut down before it can be
The socket being shut down.
Must be set to FREERTOS_SHUT_RDWR.
FreeRTOS-Plus-TCP does not currently use the xHow parameter
as it always shuts down both reads and writes. xHow is
included to ensure the function prototype conforms to the
expected Berkeley sockets standard, and for compatibility
with future FreeRTOS-Plus-TCP versions which may accept other
If the shutdown request was successful then 0 is returned. The shutdown
being complete is indicated by
calls on the socket resulting in -pdFREERTOS_ERRNO_EINVAL being returned.
If xSocket is not a valid TCP socket then -pdFREERTOS_ERRNO_EOPNOTSUPP
If xSocket is a valid TCP socket but the socket is not connected to a
remote socket then -pdFREERTOS_ERRNO_EOPNOTSUPP is returned.
Note that, because FreeRTOS does not implement errno, the
behaviour in the presence of an error is necessarily different to that of
connect() functions that are fully compliant with the expected Berkeley
The source code examples on both the
Sending TCP Data
and the Receiving TCP Data pages demonstrate a connected
socket being shut down then closed.
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.