Функция WebSocketBeginServerHandshake (websocket.h)

Статья
08/27/2023

Функция WebSocketBeginServerHandshake начинает подтверждение на стороне сервера.

Синтаксис

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
);

Параметры

[in] hWebSocket

Тип: WEB_SOCKET_HANDLE

Дескриптор сеанса WebSocket, возвращенный предыдущим вызовом WebSocketCreateServerHandle.

[in, optional] pszSubprotocolSelected

Тип: PCSTR

Указатель на значение под-протокола, выбранное приложением. Должен содержать один подпротокол.

[in, optional] pszExtensionSelected

Тип: PCSTR*

Указатель на список расширений, выбранных приложением. Должен содержать одно расширение для каждой записи.

[in] ulExtensionSelectedCount

Тип: ULONG

Число расширений в pszExtensionSelected.

[in] pRequestHeaders

Тип: const PWEB_SOCKET_HTTP_HEADER

Указатель на массив структур WEB_SOCKET_HTTP_HEADER , содержащих заголовки запросов, полученные приложением.

[in] ulRequestHeaderCount

Тип: ULONG

Количество заголовков запросов в pRequestHeaders.

[out] pResponseHeaders

Тип: PWEB_SOCKET_HTTP_HEADER*

При успешном выводе указатель на массив или WEB_SOCKET_HTTP_HEADER структуры, содержащие заголовки ответов, отправляемые приложением.

[out] pulResponseHeaderCount

Тип: ULONG*

При успешном выводе— количество заголовков ответов в pResponseHeaders.

Возвращаемое значение

Тип: HRESULT

Если функция завершается успешно, она возвращает S_OK.

Если функция завершается сбоем, она возвращает один из следующих кодов или системной ошибки , определенных в WinError.h.

Код возврата	Описание
E_INVALID_PROTOCOL_FORMAT	Данные протокола имеют недопустимый формат.

Для завершения подтверждения на стороне сервера приложения должны вызывать WebSocketEndServerHandshake или любую из функций сеанса. После завершения подтверждения между клиентом и сервером приложение может использовать функции сеанса.

Требования

Требование	Значение
Минимальная версия клиента	Windows 8 [только классические приложения]
Минимальная версия сервера	Windows Server 2012 [только классические приложения]
Целевая платформа	Windows
Header	websocket.h
Библиотека	Websocket.lib
DLL	Websocket.dll

См. также раздел

WEB_SOCKET_HTTP_HEADER

WebSocketBeginClientHandshake

WebSocketEndClientHandshake

WebSocketEndServerHandshake

Поделиться через