Función WinHttpWebSocketShutdown (winhttp.h)
La función WinHttpWebSocketShutdown envía un marco cercano a un servidor WebSocket para cerrar el canal de envío, pero deja abierto el canal de recepción.
Sintaxis
WINHTTPAPI DWORD WinHttpWebSocketShutdown(
[in] HINTERNET hWebSocket,
[in] USHORT usStatus,
[in, optional] PVOID pvReason,
[in] DWORD dwReasonLength
);
Parámetros
[in] hWebSocket
Tipo: HINTERNET
Identificador de un WebSocket.
[in] usStatus
Tipo: USHORT
Código de estado de cierre. Consulte WINHTTP_WEB_SOCKET_CLOSE_STATUS para ver los valores posibles.
[in, optional] pvReason
Tipo: PVOID
Motivo detallado del cierre.
[in] dwReasonLength
Tipo: DWORD
Longitud de pvReason, en bytes.
Si pvReason es NULL, debe ser 0. Este valor debe estar dentro del intervalo de 0 a 123.
Valor devuelto
Tipo: DWORD
Con la siguiente excepción, todos los códigos de error indican que se ha anulado la conexión TCP subyacente.
| Descripción | |
|---|---|
|
La operación se completará de forma asincrónica. |
Comentarios
WinHttpWebSocketShutdown envía un marco cercano y evita que se envíen datos adicionales a través de la conexión de WebSocket. No cierra el canal de recepción. Use WinHttpWebSocketClose cuando desee cerrar completamente la conexión y evitar las operaciones de recepción posteriores.
La aplicación es responsable de recibir el marco de cierre del servidor (a través de operaciones de recepción normales).
Después de llamar a WinHttpWebSocketShutdown , la aplicación puede llamar a WinHttpWebSocketClose si no desea recibir un marco cercano por sí mismo y delegarlo en la pila.
Requisitos
| 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 | winhttp.h |
| Library | Winhttp.lib |
| Archivo DLL | Winhttp.dll |