Compartir a través de

Función WebSocketBeginServerHandshake (websocket.h)

  • Artículo

La función WebSocketBeginServerHandshake inicia el protocolo de enlace del lado servidor.

Sintaxis

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

Parámetros

[in] hWebSocket

Tipo: WEB_SOCKET_HANDLE

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

[in, optional] pszSubprotocolSelected

Tipo: PCSTR

Puntero a un valor de subprotocolo elegido por la aplicación. Debe contener un subprotocolo.

[in, optional] pszExtensionSelected

Tipo: PCSTR*

Puntero a una lista de extensiones elegidas por la aplicación. Debe contener una extensión por entrada.

[in] ulExtensionSelectedCount

Tipo: ULONG

Número de extensiones en pszExtensionSelected.

[in] pRequestHeaders

Tipo: const PWEB_SOCKET_HTTP_HEADER

Puntero a una matriz de estructuras de WEB_SOCKET_HTTP_HEADER que contienen los encabezados de solicitud recibidos por la aplicación.

[in] ulRequestHeaderCount

Tipo: ULONG

Número de encabezados de solicitud en pRequestHeaders.

[out] pResponseHeaders

Tipo: PWEB_SOCKET_HTTP_HEADER*

En la salida correcta, un puntero a una matriz o estructuras WEB_SOCKET_HTTP_HEADER que contienen los encabezados de respuesta que va a enviar la aplicación.

[out] pulResponseHeaderCount

Tipo: ULONG*

En la salida correcta, número de encabezados de respuesta en pResponseHeaders.

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_FORMAT
 Los datos de protocolo tenían un formato no válido.

Comentarios

Para completar el protocolo de enlace del lado servidor, las aplicaciones deben llamar a WebSocketEndServerHandshake o a cualquiera de las funciones de sesión. Una vez completado el protocolo de enlace cliente-servidor, la aplicación puede usar las funciones de sesión.

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_HTTP_HEADER

WebSocketBeginClientHandshake

WebSocketEndClientHandshake

WebSocketEndServerHandshake