объединение WEB_SOCKET_BUFFER (websocket.h)

Структура WEB_SOCKET_BUFFER содержит данные для определенного действия WebSocket.

Синтаксис

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

Тип: PBYTE

Указатель на данные буфера WebSocket.

Data.ulBufferLength

Тип: ULONG

Длина буфера в байтах, на который указывает pbBuffer.

CloseStatus

CloseStatus.pbReason

Тип: PBYTE

Точка на строку UTF-8, представляющую причину закрытия подключения. Если значение ulReasonLength равно 0, это значение должно иметь значение NULL.

CloseStatus.ulReasonLength

Тип: ULONG

Длина буфера в байтах, на который указывает pbReason. Он не может превышать WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 байта).

CloseStatus.usStatus

Тип: USHORT

WEB_SOCKET_CLOSE_STATUS перечисление, указывающее состояние WebSocket.

Замечания

Приложение должно использовать структуру данных для всех типов буферов, кроме WEB_SOCKET_CLOSE_BUFFER_TYPE. Структуру CloseStatus используется для WEB_SOCKET_CLOSE_BUFFER_TYPE.

Требования

Требование	Ценность
Минимальный поддерживаемый клиент	Windows 8 [только классические приложения]
минимальный поддерживаемый сервер	Windows Server 2012 [только классические приложения]
Header	websocket.h

См. также

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend