WebSocketBeginServerHandshake-Funktion (websocket.h)

Die WebSocketBeginServerHandshake-Funktion beginnt den serverseitigen Handshake.

Syntax

HRESULT WebSocketBeginServerHandshake(
  [in]           WEB_SOCKET_HANDLE             hWebSocket,
  [in, optional] PCSTR                         pszSubprotocolSelected,
  [in, optional] PCSTR                         *pszExtensionSelected,
  [in]           ULONG                         ulExtensionSelectedCount,
  [in]           const PWEB_SOCKET_HTTP_HEADER pRequestHeaders,
  [in]           ULONG                         ulRequestHeaderCount,
  [out]          PWEB_SOCKET_HTTP_HEADER       *pResponseHeaders,
  [out]          ULONG                         *pulResponseHeaderCount
);

Parameter

[in] hWebSocket

Typ: WEB_SOCKET_HANDLE

WebSocket-Sitzungshandle, das von einem vorherigen Aufruf von WebSocketCreateServerHandle zurückgegeben wurde.

[in, optional] pszSubprotocolSelected

Typ: PCSTR

Ein Zeiger auf einen von der Anwendung ausgewählten Unterprotokollwert. Muss ein Unterprotokoll enthalten.

[in, optional] pszExtensionSelected

Typ: PCSTR*

Ein Zeiger auf eine Liste von Erweiterungen, die von der Anwendung ausgewählt werden. Muss eine Erweiterung pro Eintrag enthalten.

[in] ulExtensionSelectedCount

Typ: ULONG

Anzahl der Erweiterungen in pszExtensionSelected.

[in] pRequestHeaders

Typ: const PWEB_SOCKET_HTTP_HEADER

Zeiger auf ein Array von WEB_SOCKET_HTTP_HEADER Strukturen, die die von der Anwendung empfangenen Anforderungsheader enthalten.

[in] ulRequestHeaderCount

Typ: ULONG

Anzahl der Anforderungsheader in pRequestHeaders.

[out] pResponseHeaders

Typ: PWEB_SOCKET_HTTP_HEADER*

Bei erfolgreicher Ausgabe zeigt ein Zeiger auf ein Array oder WEB_SOCKET_HTTP_HEADER Strukturen, die die Antwortheader enthalten, die von der Anwendung gesendet werden sollen.

[out] pulResponseHeaderCount

Typ: ULONG*

Bei erfolgreicher Ausgabe die Anzahl der Antwortheader in pResponseHeaders.

Rückgabewert

Typ: HRESULT

Wenn die Funktion erfolgreich ist, gibt sie S_OK zurück.

Wenn die Funktion fehlschlägt, gibt sie einen der folgenden oder einen in WinError.h definierten Systemfehlercode zurück.

Hinweise

Um den serverseitigen Handshake abzuschließen, müssen Anwendungen WebSocketEndServerHandshake oder eine der Sitzungsfunktionen aufrufen. Sobald der Client-Server-Handshake abgeschlossen ist, kann die Anwendung die Sitzungsfunktionen verwenden.

Anforderungen

Weitere Informationen

WEB_SOCKET_HTTP_HEADER

WebSocketBeginClientHandshake

WebSocketEndClientHandshake

WebSocketEndServerHandshake