Compartir a través de

WEB_SOCKET_BUFFER unión (websocket.h)

  • Artículo

La estructura WEB_SOCKET_BUFFER contiene datos de una acción webSocket específica.

Sintaxis

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;

Miembros

Data

Data.pbBuffer

Tipo: PBYTE Puntero a los datos del búfer de WebSocket.

Data.ulBufferLength

Tipo: ULONG Longitud, en bytes, del búfer al que apunta pbBuffer.

CloseStatus

CloseStatus.pbReason

Tipo: PBYTE Un punto a una cadena UTF-8 que representa el motivo por el que se cierra la conexión. Si ulReasonLength es 0, debe ser NULL.

CloseStatus.ulReasonLength

Tipo: ULONG Longitud, en bytes, del búfer al que apunta pbReason. No puede superar WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 bytes).

CloseStatus.usStatus

Tipo: USHORT

WEB_SOCKET_CLOSE_STATUS enumeración que especifica el estado de WebSocket.

Comentarios

La aplicación debe usar la estructura Data para todos los tipos de búfer, excepto WEB_SOCKET_CLOSE_BUFFER_TYPE. La estructura CloseStatus se usa para WEB_SOCKET_CLOSE_BUFFER_TYPE.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2012 [solo aplicaciones de escritorio]
Encabezado websocket.h

Consulte también

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend