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を除くすべてのバッファー型に データ 構造体を使用する必要があります。 CloseStatus 構造体は、WEB_SOCKET_CLOSE_BUFFER_TYPEに使用されます。

Requirements

Requirement	価値
サポートされる最小クライアント	Windows 8 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップアプリのみ]
Header	websocket.h