shutdown
The Windows Sockets
shutdown function disables sends and/or receives on a socket.
int shutdown (
Parameters
s
[in] A descriptor identifying a socket.
how
[in] A flag that describes what types of operation will no longer be allowed.
Remarks
shutdown is used on all types of sockets to disable reception, transmission, or both.
If
how is SD_RECEIVE, subsequent receives on the socket will be disallowed. This has
no effect on the lower protocol layers. For TCP sockets, if there is still
data queued on the socket waiting to be received, or data arrives subsequently,
the connection is reset, since the data cannot be delivered to the user. For UDP
sockets, incoming datagrams are accepted and queued. In no case will an ICMP
error packet be generated.
If
how is SD_SEND, subsequent sends are disallowed. For TCP sockets, a FIN will be
sent.
Setting
how to SD_BOTH disables both sends and receives as described above.
Note that
shutdown does not close the socket, and resources attached to the socket will not be
freed until
closesocket is invoked.
To assure that all data is sent and received on a connected socket before it
is closed, an application should use
shutdown to close connection before calling
closesocket. For example, to initiate a graceful disconnect, an application could:
- call WSAAsyncSelect to register for FD_CLOSE notification,
- call shutdown with how=SD_SEND,
- when FD_CLOSE received, call recv until zero returned, or SOCKET_ERROR, and
- call closesocket,
Comments
shutdown does not block regardless of the SO_LINGER setting on the socket.
An application should not rely on being able to re-use a socket after it has
been shut down. In particular, a Windows Sockets provider is not required to
support the use of
connect on such a socket.
Return Values
If no error occurs,
shutdown returns zero. Otherwise, a value of SOCKET_ERROR is returned, and a specific
error code can be retrieved by calling
WSAGetLastError.
Error Codes
WSANOTINITIALISED
| A successful WSAStartup must occur before using this function.
|
WSAENETDOWN
| The network subsystem has failed.
|
WSAEINVAL
| how is not valid, or is not consistent with the socket type, for example, SD_SEND
is used with a UNI_RECV socket type.
|
WSAEINPROGRESS
| A blocking Windows Sockets 1.1 call is in progress, or the service provider is
still processing a callback function.
|
WSAENOTCONN
| The socket is not connected (connection-oriented sockets only).
|
WSAENOTSOCK
| The descriptor is not a socket.
|
See Also
connect,
socket
- Software for developers
-
Delphi Components
.Net Components
Software for Android Developers
- More information resources
-
MegaDetailed.Net
Unix Manual Pages
Delphi Examples
- Databases for Amazon shops developers
-
Amazon Categories Database
Browse Nodes Database