WEB_SOCKET_BUFFER union (websocket.h)

Struktur WEB_SOCKET_BUFFER berisi data untuk tindakan WebSocket tertentu.

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

Jenis: PBYTE

Penunjuk ke data buffer WebSocket.

Data.ulBufferLength

Jenis: ULONG

Panjang, dalam byte, dari buffer yang diacu oleh pbBuffer.

CloseStatus

CloseStatus.pbReason

Jenis: PBYTE

Titik ke string UTF-8 yang mewakili alasan koneksi ditutup. Jika ulReasonLength adalah 0, ini harus NULL.

CloseStatus.ulReasonLength

Jenis: ULONG

Panjang, dalam byte, dari buffer yang diacu oleh pbReason. Tidak boleh melebihi WEB_SOCKET_MAX_CLOSE_REASON_LENGTH (123 byte).

CloseStatus.usStatus

Jenis: USHORT

WEB_SOCKET_CLOSE_STATUS enumerasi yang menentukan status WebSocket.

Komentar

Aplikasi harus menggunakan struktur Data untuk semua jenis buffer kecuali WEB_SOCKET_CLOSE_BUFFER_TYPE. Struktur CloseStatus digunakan untuk WEB_SOCKET_CLOSE_BUFFER_TYPE.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 8 [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2012 [hanya aplikasi desktop]
Header	websocket.h

Lihat juga

WEB_SOCKET_BUFFER_TYPE

WebSocketGetAction

WebSocketReceive

WebSocketSend