Compartir a través de

Función WebSocketSend (websocket.h)

  • Artículo

La función WebSocketSend agrega una operación de envío a la cola de operaciones de componentes de protocolo.

Sintaxis

HRESULT WebSocketSend(
  [in]           WEB_SOCKET_HANDLE      hWebSocket,
  [in]           WEB_SOCKET_BUFFER_TYPE BufferType,
  [in, optional] WEB_SOCKET_BUFFER      *pBuffer,
  [in, optional] PVOID                  Context
);

Parámetros

[in] hWebSocket

Tipo: WEB_SOCKET_HANDLE

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

[in] BufferType

Tipo: WEB_SOCKET_BUFFER_TYPE

Tipo de datos de búfer de WebSocket que se van a enviar en pBuffer.

[in, optional] pBuffer

Tipo: WEB_SOCKET_BUFFER*

Puntero a una matriz de estructuras de WEB_SOCKET_BUFFER que contiene datos de búfer de WebSocket que se van a enviar. Si BufferType es WEB_SOCKET_PING_PONG_BUFFER_TYPE o WEB_SOCKET_UNSOLICITED_PONG_BUFFER_TYPE, pBuffer debe ser NULL.

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

[in, optional] Context

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.

Comentarios

Una vez que una aplicación envía correctamente un búfer de WEB_SOCKET_CLOSE_BUFFER_TYPE WebSocket, solo puede enviar fotogramas de control.

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

WebSocketReceive