union WEB_SOCKET_BUFFER (websocket.h)
La structure WEB_SOCKET_BUFFER contient des données pour une action WebSocket spécifique.
Syntaxe
typedef union _WEB_SOCKET_BUFFER {
struct {
PBYTE pbBuffer;
ULONG ulBufferLength;
} Data;
struct {
PBYTE pbReason;
ULONG ulReasonLength;
USHORT usStatus;
} CloseStatus;
} WEB_SOCKET_BUFFER, *PWEB_SOCKET_BUFFER;
Membres
Data
Data.pbBuffer
Type : PBYTE Pointeur vers les données de mémoire tampon WebSocket.
Data.ulBufferLength
Type : ULONG Longueur, en octets, de la mémoire tampon pointée par pbBuffer.
CloseStatus
CloseStatus.pbReason
Type : PBYTE Point vers une chaîne UTF-8 qui représente la raison pour laquelle la connexion est fermée. Si ulReasonLength a la valeur 0, cette valeur doit être NULL.
CloseStatus.ulReasonLength
Type : ULONG Longueur, en octets, de la mémoire tampon pointée par pbReason. Il ne peut pas dépasser WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 octets).
CloseStatus.usStatus
Type : USHORT
WEB_SOCKET_CLOSE_STATUS énumération qui spécifie le status WebSocket.
Remarques
L’application doit utiliser le struct De données pour tous les types de mémoire tampon, à l’exception de WEB_SOCKET_CLOSE_BUFFER_TYPE. Le struct CloseStatus est utilisé pour WEB_SOCKET_CLOSE_BUFFER_TYPE.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows 8 [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2012 [applications de bureau uniquement] |
| En-tête | websocket.h |