WEB_SOCKET_BUFFER Union (websocket.h)

Die WEB_SOCKET_BUFFER-Struktur enthält Daten für eine bestimmte WebSocket-Aktion.

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;

Member

Data

Data.pbBuffer

Typ: PBYTE Zeiger auf die WebSocket-Pufferdaten.

Data.ulBufferLength

Typ: ULONG Länge des Puffers in Byte, auf den pbBuffer verweist.

CloseStatus

CloseStatus.pbReason

Typ: PBYTE Ein Punkt auf eine UTF-8-Zeichenfolge, die den Grund darstellt, warum die Verbindung geschlossen wird. Wenn ulReasonLength 0 ist, muss dies NULL sein.

CloseStatus.ulReasonLength

Typ: ULONG Länge des Puffers in Byte, auf den pbReason verweist. Sie darf WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 Byte) nicht überschreiten.

CloseStatus.usStatus

Typ: USHORT

WEB_SOCKET_CLOSE_STATUS Enumeration, die die WebSocket-status angibt.

Hinweise

Die Anwendung muss die Datenstruktur für alle Puffertypen außer WEB_SOCKET_CLOSE_BUFFER_TYPE verwenden. Die CloseStatus-Struktur wird für WEB_SOCKET_CLOSE_BUFFER_TYPE verwendet.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Kopfzeile	websocket.h

Weitere Informationen

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend