WebSocket.CloseAsync(WebSocketCloseStatus, String, CancellationToken) Método

Definición

Espacio de nombres:

System.Net.WebSockets

Ensamblado:

System.Net.WebSockets.dll

Source:

WebSocket.cs

Cierra la conexión de WebSocket como una operación asincrónica mediante el protocolo de enlace de cierre definido en la sección 7 de la especificación del protocolo WebSocket.

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

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

abstract member CloseAsync : System.Net.WebSockets.WebSocketCloseStatus * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

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

Parámetros

closeStatus

WebSocketCloseStatus

Indica el motivo para cerrar la conexión de WebSocket.

statusDescription

String

Especifica una explicación legible acerca de por qué se cierra la conexión.

cancellationToken

CancellationToken

Token que se usa para propagar la notificación de que se deben cancelar esas operaciones.

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á después de que se haya cerrado WebSocket.

Este método cierra la conexión de WebSocket mediante el protocolo de enlace de cierre definido en la sección 7 de la especificación del protocolo WebSocket .