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

Définition

Espace de noms:

System.Net.WebSockets

Assembly:

System.Net.WebSockets.dll

Source:

WebSocket.cs

Ferme la connexion de WebSocket en tant qu’opération asynchrone à l’aide du protocole de transfert de fermeture défini dans la section 7 de la spécification du protocole 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

Paramètres

closeStatus

WebSocketCloseStatus

Indique la raison de la fermeture de la connexion de WebSocket.

statusDescription

String

Spécifie une explication lisible du motif de fermeture de la connexion.

cancellationToken

CancellationToken

Jeton qui peut être utilisé pour propager la notification d’annulation des opérations.

Retours

Task

Objet de tâche représentant l'opération asynchrone.

Exceptions

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

Cette opération ne se bloque pas. L’objet retourné Task se termine une fois le WebSocket fermé.

Cette méthode ferme la connexion WebSocket à l’aide de la liaison de fermeture définie dans la section 7 de la spécification du protocole WebSocket .