Passer au contenu principal

HCWebSocketCloseEventFunction

Rappel défini par l’application qui est appelé lorsqu’un WebSocket est fermé. Passez-le à HCWebSocketCreate.

Syntaxe

Paramètres

websocket   _In_
Type : HCWebsocketHandle
Le descripteur du WebSocket. closeStatus   _In_
Type : HCWebSocketCloseStatus
La raison de la fermeture du WebSocket, par exemple HCWebSocketCloseStatus::Normal (1000), HCWebSocketCloseStatus::GoingAway (1001) ou HCWebSocketCloseStatus::TooLarge (1009). HCWebSocketCloseStatus est déclaré dans pal.h. functionContext   _In_
Type : void*
Le contexte client que vous avez passé à HCWebSocketCreate.

Valeur de retour

Type : void

Remarques

libHttpClient appelle ce rappel lorsqu’il constate que le WebSocket s’est fermé, par exemple après que vous avez appelé HCWebSocketDisconnect ou HCWebSocketDisconnectWithStatus, ou lorsque l’homologue ferme la connexion. Ne vous fiez pas à ce rappel pour savoir qu’une tentative de connexion a échoué. Pour vérifier le résultat d’une tentative de connexion, appelez HCGetWebSocketConnectResult. La notification de fermeture ne libère pas votre référence au descripteur. Lorsque vous avez terminé avec le descripteur, appelez HCWebSocketCloseHandle. Il n’est pas garanti que ce rappel soit distribué par la XTaskQueue que vous avez passée à HCWebSocketConnectAsync ni par un port d’achèvement de XTaskQueue. Il peut s’exécuter sur un thread géré par le fournisseur ou autrement défini par l’implémentation. Votre gestionnaire est responsable de toute sécurité des threads requise, ou du marshaling du travail vers le contexte d’exécution de votre choix.

Configuration requise

En-tête : httpClient.h Bibliothèque : libHttpClient.lib Plateformes prises en charge : Windows, consoles de la famille XBOX One et consoles XBOX Series

Voir aussi

httpClient
HCWebSocketCreate
HCWebSocketDisconnectWithStatus
Dernière modification le 3 novembre 2026