AspNetWebSocket.CloseAsync Méthode

Définition

Espace de noms:

System.Web.WebSockets

Assembly:

System.Web.dll

Envoie un message asynchrone à un client pour fermer la connexion. Si le serveur initialise la demande de fermer la connexion, la méthode attend que le client réponde à la demande avant de retourner.

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

Paramètres

closeStatus

WebSocketCloseStatus

Code d'état de l'opération de fermeture.

statusDescription

String

Message d'état de l'opération de fermeture.

cancellationToken

CancellationToken

Objet qui annule une opération en attente.

Retours

Task

Référence à une opération.

Exceptions

ObjectDisposedException

L'objet AspNetWebSocket était supprimé.

InvalidOperationException

L'objet AspNetWebSocket est dans un état abandonné.

- ou -

Les opérations d'envoi sont pas disponibles.

- ou -

Les opérations de réception ne sont pas disponibles.

OperationCanceledException

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

Remarques

Vous pouvez utiliser les méthodes et CloseOutputAsync pour les demandes initiées par le CloseAsync client et le serveur afin de fermer une AspNetWebSocket connexion. Les deux méthodes gèrent les requêtes initiées par le client de la même façon : une fois que le client a envoyé un message au serveur pour fermer la connexion, le serveur appelle l’une de ces méthodes et envoie un accusé de réception au client, puis la méthode retourne.

Pour les requêtes initiées par le serveur, les deux méthodes fonctionnent différemment. La CloseAsync méthode envoie un message au client pour fermer la connexion, attend une réponse, puis retourne. Le serveur n’attend aucune donnée supplémentaire envoyée par le client. En revanche, la CloseOutputAsync méthode envoie un message au client pour fermer la connexion et retourne sans attendre de réponse. Une fois la méthode retournée, vous pouvez appeler la ReceiveAsync méthode et gérer les données supplémentaires ou l’accusé de réception que le client envoie.