websocket.h (WEB_SOCKET_PROPERTY_TYPE 列舉)

WEB_SOCKET_PROPERTY_TYPE列舉會指定 WebSocket 屬性類型。

Syntax

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 個位元組。 預設值為 使用 WebSocketCreateClientHandle建立的控制碼上為 4096，而使用 WebSocketCreateServerHandle建立的控制碼則為 16。 與 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 屬性是間隔，以毫秒為單位，透過連線傳送 Keep-alive 封包。 預設間隔為 30000 (30 秒) 。 最小間隔為 15000 (15 秒) 。 注意 保持運作間隔的預設值是從 HKLM：\SOFTWARE\Microsoft\WebSocket\KeepaliveInterval讀取。 如果未設定值，則會使用預設值 30000。 無法讓保留間隔低於 15000 毫秒。 如果設定較低的值，則會使用 15000 毫秒。   與 WebSocketGetGlobalProperty搭配使用。
WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE 值： 6 屬性類型： ULONG 陣列 WebSocket 屬性是支援的 WebSocket 通訊協定版本。 與 WebSocketGetGlobalProperty搭配使用。

規格需求

最低支援的用戶端	Windows 8 [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2012 [僅限傳統型應用程式]
標頭	websocket.h

另請參閱

WEB_SOCKET_PROPERTY

WebSocketReceive

WebSocketSend