ClientWebSocket.CloseAsync Method

Reference

Definition

Namespace:: System.Net.WebSockets

Assemblies:: netstandard.dll, System.Net.WebSockets.Client.dll

Assembly:: System.Net.WebSockets.Client.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: ClientWebSocket.cs

Source:: ClientWebSocket.cs

Source:: ClientWebSocket.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Close the ClientWebSocket instance as an asynchronous operation.

public:
 override System::Threading::Tasks::Task ^ CloseAsync(System::Net::WebSockets::WebSocketCloseStatus closeStatus, System::String ^ statusDescription, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task CloseAsync(System.Net.WebSockets.WebSocketCloseStatus closeStatus, string? statusDescription, System.Threading.CancellationToken cancellationToken);

public override System.Threading.Tasks.Task CloseAsync(System.Net.WebSockets.WebSocketCloseStatus closeStatus, string statusDescription, System.Threading.CancellationToken cancellationToken);

override this.CloseAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function CloseAsync (closeStatus As WebSocketCloseStatus, statusDescription As String, cancellationToken As CancellationToken) As Task

Parameters

closeStatus: WebSocketCloseStatus

The WebSocket close status.

statusDescription: String

A description of the close status.

cancellationToken: CancellationToken

A cancellation token used to propagate notification that this operation should be canceled.

Returns

Task

The task object representing the asynchronous operation.

Exceptions

OperationCanceledException

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

Remarks

This operation will not block. The returned Task object will complete after the ClientWebSocket instance is closed.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via