共用方式為


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;

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 外)使用 Data 結構。 CloseStatus 結構用於WEB_SOCKET_CLOSE_BUFFER_TYPE

需求

Requirement 價值觀
最低支援的用戶端 Windows 8 [僅限傳統型應用程式]
支援的最低伺服器 Windows Server 2012 [僅限傳統型應用程式]
Header Websocket.h

另請參閱

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend