WEB_SOCKET_BUFFER união (websocket.h)

A estrutura WEB_SOCKET_BUFFER contém dados para uma ação WebSocket específica.

Sintaxe

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

Tipo: PBYTE

Ponteiro para os dados de buffer do WebSocket.

Data.ulBufferLength

Tipo: ULONG

Comprimento, em bytes, do buffer apontado por pbBuffer.

CloseStatus

CloseStatus.pbReason

Tipo: PBYTE

Um ponto para uma cadeia de caracteres UTF-8 que representa o motivo pelo qual a conexão está fechada. Se ulReasonLength for 0, isso deverá ser NULL.

CloseStatus.ulReasonLength

Tipo: ULONG

Comprimento, em bytes, do buffer apontado por pbReason. Não pode exceder WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 bytes).

CloseStatus.usStatus

Tipo: USHORT

WEB_SOCKET_CLOSE_STATUS enumeração que especifica o status do WebSocket.

Observações

O aplicativo deve usar o struct de dados para todos os tipos de buffer, exceto WEB_SOCKET_CLOSE_BUFFER_TYPE. O struct CloseStatus é usado para WEB_SOCKET_CLOSE_BUFFER_TYPE.

Requirements

Requirement	Value
Cliente mínimo suportado	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo compatível	Windows Server 2012 [somente aplicativos da área de trabalho]
Header	websocket.h

Consulte também

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend