Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WINHTTP_WEB_SOCKET_CLOSE_STATUS enumeration

The WINHTTP_WEB_SOCKET_CLOSE_STATUS enumeration includes the status of a WebSocket close operation.

Syntax


typedef enum _WINHTTP_WEB_SOCKET_CLOSE_STATUS { 
  WINHTTP_WEB_SOCKET_SUCCESS_CLOSE_STATUS                 = 1000,
  WINHTTP_WEB_SOCKET_ENDPOINT_TERMINATED_CLOSE_STATUS     = 1001,
  WINHTTP_WEB_SOCKET_PROTOCOL_ERROR_CLOSE_STATUS          = 1002,
  WINHTTP_WEB_SOCKET_INVALID_DATA_TYPE_CLOSE_STATUS       = 1003,
  WINHTTP_WEB_SOCKET_EMPTY_CLOSE_STATUS                   = 1005,
  WINHTTP_WEB_SOCKET_ABORTED_CLOSE_STATUS                 = 1006,
  WINHTTP_WEB_SOCKET_INVALID_UTF8_CLOSE_STATUS            = 1007,
  WINHTTP_WEB_SOCKET_POLICY_VIOLATION_CLOSE_STATUS        = 1008,
  WINHTTP_WEB_SOCKET_MESSAGE_TOO_BIG_CLOSE_STATUS         = 1009,
  WINHTTP_WEB_SOCKET_UNSUPPORTED_EXTENSIONS_CLOSE_STATUS  = 1010,
  WINHTTP_WEB_SOCKET_SERVER_ERROR_CLOSE_STATUS            = 1011,
  WINHTTP_WEB_SOCKET_SECURE_HANDSHAKE_ERROR_CLOSE_STATUS  = 1015
} WINHTTP_WEB_SOCKET_CLOSE_STATUS;

Constants

WINHTTP_WEB_SOCKET_SUCCESS_CLOSE_STATUS

The connection closed successfully.

WINHTTP_WEB_SOCKET_ENDPOINT_TERMINATED_CLOSE_STATUS

The peer is going away and terminating the connection.

WINHTTP_WEB_SOCKET_PROTOCOL_ERROR_CLOSE_STATUS

A protocol error occurred.

WINHTTP_WEB_SOCKET_INVALID_DATA_TYPE_CLOSE_STATUS

Invalid data received by the peer.

WINHTTP_WEB_SOCKET_EMPTY_CLOSE_STATUS

The close message was empty.

WINHTTP_WEB_SOCKET_ABORTED_CLOSE_STATUS

The connection was aborted.

WINHTTP_WEB_SOCKET_INVALID_UTF8_CLOSE_STATUS

UTF-8 frame carried an invalid UTF-8 stream.

WINHTTP_WEB_SOCKET_POLICY_VIOLATION_CLOSE_STATUS

The message violates an endpoint's policy.

WINHTTP_WEB_SOCKET_MESSAGE_TOO_BIG_CLOSE_STATUS

The message sent was too large to process.

WINHTTP_WEB_SOCKET_UNSUPPORTED_EXTENSIONS_CLOSE_STATUS

A client endpoint expected the server to negotiate one or more extensions, but the server didn't return them in the response message of the WebSocket handshake.

WINHTTP_WEB_SOCKET_SERVER_ERROR_CLOSE_STATUS

An unexpected condition prevented the server from fulfilling the request.

WINHTTP_WEB_SOCKET_SECURE_HANDSHAKE_ERROR_CLOSE_STATUS

The TLS handshake could not be completed.

Remarks

WINHTTP_WEB_SOCKET_CLOSE_STATUS is used by WinHttpWebSocketClose, WinHttpWebSocketShutdown, and WinHttpWebSocketQueryCloseStatus.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Winhttp.h

See also

WinHttpWebSocketClose
WinHttpWebSocketShutdown
WinHttpWebSocketQueryCloseStatus

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.