This page is Almost Ready

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

code

Summary

The WebSocket connection close code provided by the server.

Property of apis/websocket/CloseEventapis/websocket/CloseEvent

Syntax

Note: This property is read-only.

var result = element.code;

Return Value

Returns an object of type unsigned shortunsigned short

Status codeNameDescription
0-999Reserved and not used.
1000CLOSE_NORMALNormal closure; the connection successfully completed whatever purpose for which it was created.
1001CLOSE_GOING_AWAYThe endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.
1002CLOSE_PROTOCOL_ERRORThe endpoint is terminating the connection due to a protocol error.
1003CLOSE_UNSUPPORTEDThe connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).
1004CLOSE_TOO_LARGEThe endpoint is terminating the connection because a data frame was received that is too large.
1005CLOSE_NO_STATUS Reserved.Indicates that no status code was provided even though one was expected.
1006CLOSE_ABNORMAL Reserved.Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.
1007-1999Reserved for future use by the WebSocket standard.
2000-2999Reserved for use by WebSocket extensions.
3000-3999Available for use by libraries and frameworks. May not be used by applications.
4000-4999Available for use by applications.

Related specifications

W3C WebSocket Specification
W3C Candidate Recommendation

Attributions