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;

Members

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 l’état de WebSocket.

Remarques

L’application doit utiliser le struct de données pour tous les types de mémoires tampons, sauf WEB_SOCKET_CLOSE_BUFFER_TYPE. Le struct CloseStatus est utilisé pour WEB_SOCKET_CLOSE_BUFFER_TYPE.

Spécifications

Voir aussi

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend