Socket.DisconnectAsync Method

Definition

Namespace:

System.Net.Sockets

Assembly:

System.Net.Sockets.dll

Overloads

DisconnectAsync(SocketAsyncEventArgs)	Begins an asynchronous request to disconnect from a remote endpoint.
DisconnectAsync(Boolean, CancellationToken)	Disconnects a connected socket from the remote host.

DisconnectAsync(SocketAsyncEventArgs)

Source:

Socket.cs

Begins an asynchronous request to disconnect from a remote endpoint.

public:
 bool DisconnectAsync(System::Net::Sockets::SocketAsyncEventArgs ^ e);

public bool DisconnectAsync (System.Net.Sockets.SocketAsyncEventArgs e);

member this.DisconnectAsync : System.Net.Sockets.SocketAsyncEventArgs -> bool

Public Function DisconnectAsync (e As SocketAsyncEventArgs) As Boolean

Parameters

e

SocketAsyncEventArgs

The SocketAsyncEventArgs object to use for this asynchronous socket operation.

Returns

Boolean

true if the I/O operation is pending. The Completed event on the e parameter will be raised upon completion of the operation.

false if the I/O operation completed synchronously. In this case, The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation.

Exceptions

ArgumentNullException

The e parameter cannot be null.

InvalidOperationException

A socket operation was already in progress using the SocketAsyncEventArgs object specified in the e parameter.

ObjectDisposedException

The Socket has been closed.

SocketException

An error occurred when attempting to access the socket.

Remarks

When using a connection-oriented protocol, calling the DisconnectAsync method requests a disconnect from a remote endpoint. If you set SocketAsyncEventArgs.DisconnectReuseSocket to true in the e parameter, the socket can be reused.

See also

• SocketAsyncEventArgs
• Completed
• DisconnectReuseSocket

DisconnectAsync(Boolean, CancellationToken)

Source:

Socket.Tasks.cs

Disconnects a connected socket from the remote host.

public System.Threading.Tasks.ValueTask DisconnectAsync (bool reuseSocket, System.Threading.CancellationToken cancellationToken = default);

member this.DisconnectAsync : bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function DisconnectAsync (reuseSocket As Boolean, Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parameters

reuseSocket

Boolean

Indicates whether the socket should be available for reuse after disconnect.

cancellationToken

CancellationToken

A cancellation token that can be used to cancel the asynchronous operation.

Returns

ValueTask

An asynchronous task that completes when the socket is disconnected.

Exceptions

ObjectDisposedException

The Socket object has been closed.

SocketException

An error occurred when attempting to access the socket.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Disconnect(Boolean).