ClientWebSocket.CloseAsync Método

Definición

Espacio de nombres:

System.Net.WebSockets

Ensamblado:

System.Net.WebSockets.Client.dll

Source:

ClientWebSocket.cs

Cierra una instancia ClientWebSocket como una operación asincrónica.

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);

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

Parámetros

closeStatus

WebSocketCloseStatus

Estado de cierre de WebSocket.

statusDescription

String

Descripción del estado de cierre.

cancellationToken

CancellationToken

Token de cancelación que se usa para propagar la notificación de que se debería cancelar esta operación.

Devoluciones

Task

Objeto de tarea que representa la operación asincrónica.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Esta operación no se bloqueará. El objeto devuelto Task se completará una vez cerrada la ClientWebSocket instancia.