Función WebSocketReceive (websocket.h)

La función WebSocketReceive agrega una operación de recepción a la cola de operaciones de componentes de protocolo.

Sintaxis

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

Parámetros

[in] hWebSocket

Tipo: WEB_SOCKET_HANDLE

Identificador de sesión de WebSocket devuelto por una llamada anterior a WebSocketCreateClientHandle o WebSocketCreateServerHandle.

[in, optional] pBuffer

Tipo: WEB_SOCKET_BUFFER*

Puntero a una matriz de estructuras de WEB_SOCKET_BUFFER en las que se escribirán los datos de WebSocket cuando WebSocketGetAction lo devuelva. Si es NULL, WebSocketGetAction devolverá un búfer interno que permita escenarios de copia cero.

Nota Una vez que WebSocketGetAction devuelve WEB_SOCKET_INDICATE_RECEIVE_COMPLETE para esta acción, se puede reclamar el puntero de memoria a pBuffer.

 

[in, optional] pvContext

Tipo: PVOID

Puntero a un identificador de contexto de aplicación que devolverá una llamada posterior a WebSocketGetAction.

Valor devuelto

Tipo: HRESULT

Si la función se ejecuta correctamente, devuelve S_OK.

Si se produce un error en la función, devuelve uno de los siguientes o un código de error del sistema definido en WinError.h.

Código devuelto	Descripción
E_INVALID_PROTOCOL_OPERATION	El protocolo realizó una operación no válida.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2012 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	websocket.h
Library	Websocket.lib
Archivo DLL	Websocket.dll

Consulte también

WEB_SOCKET_ACTION

WebSocketAbortHandle

WebSocketCompleteAction

WebSocketGetAction

WebSocketSend