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;

メンバー

Data

Data.pbBuffer

種類: PBYTE WebSocket バッファー データへのポインター。

Data.ulBufferLength

種類: ULONGpbBuffer が指すバッファーの長さ (バイト単位)。

CloseStatus

CloseStatus.pbReason

種類: PBYTE 接続が閉じられる理由を表す UTF-8 文字列を指す 。 ulReasonLength が 0 の場合、これは NULL である必要があります。

CloseStatus.ulReasonLength

種類: ULONGpbReason が指すバッファーの長さ (バイト単位)。 WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 バイト) を超えることはできません。

CloseStatus.usStatus

種類: USHORT

webSocket の 状態を指定する列挙をWEB_SOCKET_CLOSE_STATUSします。

注釈

アプリケーションでは、WEB_SOCKET_CLOSE_BUFFER_TYPEを除くすべてのバッファー型に 対してデータ 構造体 を使用する必要があります。 CloseStatus 構造体は、WEB_SOCKET_CLOSE_BUFFER_TYPEに使用されます。

要件

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

こちらもご覧ください

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend