• Article

Socket.Shutdown Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Disables sends and receives on a Socket.

Namespace:  System.Net.Sockets
Assembly:  System.Net (in System.Net.dll)

Syntax

'Declaration
Public Sub Shutdown ( _
    how As SocketShutdown _
)

public void Shutdown(
    SocketShutdown how
)

Parameters

Exceptions

Exception Condition
SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.
ObjectDisposedException

The Socket has been closed.

Remarks

When using a connection-oriented Socket, always call the Shutdown method before closing the Socket. This ensures that all data is sent and received on the connected socket before it is closed.

Call the Close method to free all managed and unmanaged resources associated with the Socket. Do not attempt to reuse the Socket after closing.

The following table shows the SocketShutdown enumeration values that are valid for the how parameter.

Value

Description

Send

Disable sending on this Socket.

Receive

Disable receiving on this Socket.

Both

Disable both sending and receiving on this Socket.

Setting how to Send specifies that subsequent calls to SendAsync are not allowed.

Setting how to Receive specifies that subsequent calls to ReceiveAsync are not allowed. This has no effect on lower protocol layers. For a connection-oriented protocol, the connection is terminated if either of the following conditions exist after a call to Shutdown :

  • Data is in the incoming network buffer waiting to be received.

  • More data has arrived.

Setting how to Both disables both sends and receives as described above.

NoteNote:

If you receive a SocketException when calling this method, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.