Función WebSocketBeginClientHandshake (websocket.h)
La función WebSocketBeginClientHandshake comienza el protocolo de enlace del lado cliente.
Sintaxis
HRESULT WebSocketBeginClientHandshake(
[in] WEB_SOCKET_HANDLE hWebSocket,
[in, optional] PCSTR *pszSubprotocols,
[in] ULONG ulSubprotocolCount,
[in, optional] PCSTR *pszExtensions,
[in] ULONG ulExtensionCount,
[in, optional] const PWEB_SOCKET_HTTP_HEADER pInitialHeaders,
[in] ULONG ulInitialHeaderCount,
[out] PWEB_SOCKET_HTTP_HEADER *pAdditionalHeaders,
[out] ULONG *pulAdditionalHeaderCount
);
Parámetros
[in] hWebSocket
Tipo: WEB_SOCKET_HANDLE
Identificador de sesión de WebSocket devuelto por una llamada anterior a WebSocketCreateClientHandle.
[in, optional] pszSubprotocols
Tipo: PCSTR*
Puntero a una matriz de sub-protocolos elegidos por la aplicación. Una vez completado el protocolo de enlace cliente-servidor, la aplicación debe usar el subprotocolo devuelto por WebSocketEndClientHandshake. Debe contener un subprotocolo por entrada.
[in] ulSubprotocolCount
Tipo: ULONG
Número de subprotocolos en pszSubprotocols.
[in, optional] pszExtensions
Tipo: PCSTR*
Puntero a una matriz de extensiones elegidas por la aplicación. Una vez completado el protocolo de enlace cliente-servidor, la aplicación debe usar la extensión devuelta por WebSocketEndClientHandshake. Debe contener una extensión por entrada.
[in] ulExtensionCount
Tipo: ULONG
Número de extensiones en pszExtensions.
[in, optional] pInitialHeaders
Tipo: const PWEB_SOCKET_HTTP_HEADER
Puntero a una matriz de estructuras de WEB_SOCKET_HTTP_HEADER que contienen los encabezados de solicitud que va a enviar la aplicación. La matriz debe incluir el encabezado HTTP del host tal y como se define en RFC 2616.
[in] ulInitialHeaderCount
Tipo: ULONG
Número de encabezados de solicitud en pInitialHeaders.
[out] pAdditionalHeaders
Tipo: PWEB_SOCKET_HTTP_HEADER
En la salida correcta, puntero a una matriz de estructuras de WEB_SOCKET_HTTP_HEADER que contienen los encabezados de solicitud que va a enviar la aplicación. Si se especificó alguno de estos encabezados en pInitialHeaders, el encabezado debe reemplazarse.
[out] pulAdditionalHeaderCount
Tipo: ULONG*
En la salida correcta, número de encabezados de respuesta en pAdditionalHeaders.
Valor devuelto
Tipo: HRESULT
Si la función se ejecuta correctamente, devuelve S_OK.
Si se produce un error en la función, devuelve un código de error del sistema definido en WinError.h.
Comentarios
Para completar el protocolo de enlace del lado cliente, las aplicaciones deben llamar a WebSocketEndClientHandshake. 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 |