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

перечисление WEB_SOCKET_PROPERTY_TYPE (websocket.h)

  • Статья

Перечисление WEB_SOCKET_PROPERTY_TYPE указывает тип свойства WebSocket.

Синтаксис

typedef enum _WEB_SOCKET_PROPERTY_TYPE {
  WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0,
  WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1,
  WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2,
  WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3,
  WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4,
  WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5,
  WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6
} WEB_SOCKET_PROPERTY_TYPE;

Константы

 
WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE
Значение: 0
Тип свойства: ULONG

Свойство WebSocket — это внутренний размер буфера приема. Буфер не может быть меньше 256 байт.

Значение по умолчанию — 4096.

Используется с WebSocketCreateClientHandle и WebSocketCreateServerHandle.
WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE
Значение: 1
Тип свойства: ULONG

Свойство WebSocket — это размер внутреннего буфера отправки. Буфер не может быть меньше 256 байт.

Значение по умолчанию — 4096 для дескриптора, созданного с помощью WebSocketCreateClientHandle, и 16 для дескриптора, созданного с помощью WebSocketCreateServerHandle.

Используется с WebSocketCreateClientHandle и WebSocketCreateServerHandle.
WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE
Значение: 2
Тип свойства: BOOL

Свойство WebSocket отключает бит маски в клиентских кадрах. На клиенте это свойство задает для ключа маски значение 0. На сервере это свойство позволяет серверу принимать клиентские кадры с битом маски, равным 0. Это свойство может иметь серьезные последствия для безопасности.
По умолчанию это свойство не используется и маскирование включено.

Используется с WebSocketCreateClientHandle и WebSocketCreateServerHandle.
WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE
Значение: 3
Тип свойства: PVOID

Свойство WebSocket — это буфер, который используется в качестве внутреннего буфера. Если переданный буфер не используется, за управление буфером отвечает библиотека WebSocket.
Переданный буфер должен быть выровнен по 8-байтовой границе и быть больше размера буфера приема + размер буфера отправки + 256 байт.

Используется с WebSocketCreateClientHandle и WebSocketCreateServerHandle.
WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE
Значение: 4
Тип свойства: BOOL

Свойство WebSocket отключает проверку UTF-8.

Используется с WebSocketCreateClientHandle и WebSocketCreateServerHandle.
WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE
Значение: 5
Тип свойства: ULONG

Свойство WebSocket — это интервал (в миллисекундах) для отправки сохраняемого пакета через подключение. Интервал по умолчанию — 30 000 (30 секунд). Минимальный интервал — 15 000 (15 секунд).
Примечание Значение по умолчанию для интервала поддержания активности считывается из HKLM:\SOFTWARE\Microsoft\WebSocket\KeepaliveInterval. Если значение не задано, будет использоваться значение по умолчанию 30000. Невозможно иметь более низкий интервал удержания, чем 15 000 миллисекундах. Если задано меньшее значение, будет использоваться 15 000 миллисекунда.

 



Используется с WebSocketGetGlobalProperty.
WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE
Значение: 6
Тип свойства: массив ULONG

Свойство WebSocket — это поддерживаемые версии протокола WebSocket.


Используется с WebSocketGetGlobalProperty.

Требования

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

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

WEB_SOCKET_PROPERTY

WebSocketReceive

WebSocketSend