WEB_SOCKET_BUFFER union （websocket.h）

WEB_SOCKET_BUFFER结构包含特定 WebSocket作的数据。

Syntax

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。

要求

Requirement	价值
最低支持的客户端	Windows 8 [仅限桌面应用]
支持的最低服务器	Windows Server 2012 [仅限桌面应用]
Header	websocket.h

另请参阅

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend