Поделиться через

WEB_SOCKET_BUFFER union (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;

Члены

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. Для WEB_SOCKET_CLOSE_BUFFER_TYPE используется структуру CloseStatus.

Требования

Требование Значение
Минимальная версия клиента Windows 8 [только классические приложения]
Минимальная версия сервера Windows Server 2012 [только классические приложения]
Верхняя часть websocket.h

См. также раздел

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend