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

Статья
03/03/2024

Функция WebSocketReceive добавляет операцию получения в очередь операций компонента протокола.

Синтаксис

HRESULT WebSocketReceive(
  [in]           WEB_SOCKET_HANDLE hWebSocket,
  [in, optional] WEB_SOCKET_BUFFER *pBuffer,
  [in, optional] PVOID             pvContext
);

Параметры

[in] hWebSocket

Тип: WEB_SOCKET_HANDLE

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

[in, optional] pBuffer

Тип: WEB_SOCKET_BUFFER*

Указатель на массив WEB_SOCKET_BUFFER структур, в которые будут записываться данные WebSocket при их возвращении WebSocketGetAction. Если значение РАВНО NULL, WebSocketGetAction вернет внутренний буфер, который позволяет выполнять сценарии нулевого копирования.

Примечание После того как webSocketGetAction возвращает WEB_SOCKET_INDICATE_RECEIVE_COMPLETE для этого действия, можно освободить указатель на память с помощью pBuffer .

[in, optional] pvContext

Тип: PVOID

Указатель на дескриптор контекста приложения, который будет возвращен последующим вызовом WebSocketGetAction.

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

Тип: HRESULT

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

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

Код возврата	Описание
E_INVALID_PROTOCOL_OPERATION	Протокол выполнил недопустимую операцию.

Требования

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

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

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend

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