通过

WebSocketReceive 函数 (websocket.h)

  • 项目

WebSocketReceive 函数将接收操作添加到协议组件操作队列。

语法

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

参数

[in] hWebSocket

类型： WEB_SOCKET_HANDLE

以前调用 WebSocketCreateClientHandle 或 WebSocketCreateServerHandle 返回 的 WebSocket 会话句柄。

[in, optional] pBuffer

类型： WEB_SOCKET_BUFFER*

指向 webSocketGetAction 返回 WebSocket 数据时将写入的 WEB_SOCKET_BUFFER 结构的数组 的指针。 如果 为 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
标头 websocket.h
Library Websocket.lib
DLL Websocket.dll

另请参阅

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend