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

Définition

Espace de noms:
System.Net.WebSockets
Assemblys:
netstandard.dll, System.Net.WebSockets.dll
Assembly:
System.Net.WebSockets.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
WebSocket.cs
Source:
WebSocket.cs
Source:
WebSocket.cs
Source:
WebSocket.cs
Source:
WebSocket.cs

Ferme la connexion WebSocket en tant qu’opération asynchrone à l’aide de la négociation de fermeture définie dans la spécification du protocole WebSocket, section 7.

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

statusDescription
String

Spécifie une explication lisible par l’homme quant à la raison pour laquelle la connexion est fermée.

cancellationToken
CancellationToken

Jeton qui peut être utilisé pour propager la notification que les opérations doivent être annulées.

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 bloque pas. L’objet retourné Task se termine une fois le WebSocket fermé.

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

S’applique à