A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute.
Documentation CloseEvent by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Constructor
Variables
Returns an unsigned short containing the close code send by the server. The following values are permitted status codes. The following definitions are sourced from the IANA website [Ref]. Note that the 1xxx codes are only WebSocket-internal and not for the same meaning by the transported data (like when the application-layer protocol is invalid). The only permitted codes to be specified in Firefox are 1000 and 3000 to 4999 [Source, Bug].
<tr>
<td class="header">Status code</td>
<td class="header">Name</td>
<td class="header">Description</td>
</tr>
<tr>
<td><code>0</code>–<code>999</code></td>
<td> </td>
<td>Reserved and not used.</td>
</tr>
<tr>
<td><code>1000</code></td>
<td>Normal Closure</td>
<td>Normal closure; the connection successfully completed whatever purpose for which it was created.</td>
</tr>
<tr>
<td><code>1001</code></td>
<td>Going Away</td>
<td>The endpoint is going away, either because of a server failure or because the browser is navigating away from the page that opened the connection.</td>
</tr>
<tr>
<td><code>1002</code></td>
<td>Protocol Error</td>
<td>The endpoint is terminating the connection due to a protocol error.</td>
</tr>
<tr>
<td><code>1003</code></td>
<td>Unsupported Data</td>
<td>The connection is being terminated because the endpoint received data of a type it cannot accept (for example, a text-only endpoint received binary data).</td>
</tr>
<tr>
<td><code>1004</code></td>
<td> </td>
<td>Reserved. A meaning might be defined in the future.</td>
</tr>
<tr>
<td><code>1005</code></td>
<td>No Status Recvd</td>
<td>Reserved. Indicates that no status code was provided even though one was expected.</td>
</tr>
<tr>
<td><code>1006</code></td>
<td>Abnormal Closure</td>
<td>Reserved. Used to indicate that a connection was closed abnormally (that is, with no close frame being sent) when a status code is expected.</td>
</tr>
<tr>
<td><code>1007</code></td>
<td>Invalid frame payload data</td>
<td>The endpoint is terminating the connection because a message was received that contained inconsistent data (e.g., non-UTF-8 data within a text message).</td>
</tr>
<tr>
<td><code>1008</code></td>
<td>Policy Violation</td>
<td>The endpoint is terminating the connection because it received a message that violates its policy. This is a generic status code, used when codes 1003 and 1009 are not suitable.</td>
</tr>
<tr>
<td><code>1009</code></td>
<td>Message too big</td>
<td>The endpoint is terminating the connection because a data frame was received that is too large.</td>
</tr>
<tr>
<td><code>1010</code></td>
<td>Missing Extension</td>
<td>The client is terminating the connection because it expected the server to negotiate one or more extension, but the server didn't.</td>
</tr>
<tr>
<td><code>1011</code></td>
<td>Internal Error</td>
<td>The server is terminating the connection because it encountered an unexpected condition that prevented it from fulfilling the request.</td>
</tr>
<tr>
<td><code>1012</code></td>
<td>Service Restart</td>
<td>The server is terminating the connection because it is restarting. [Ref]</td>
</tr>
<tr>
<td><code>1013</code></td>
<td>Try Again Later</td>
<td>The server is terminating the connection due to a temporary condition, e.g. it is overloaded and is casting off some of its clients. [Ref]</td>
</tr>
<tr>
<td><code>1014</code></td>
<td>Bad Gateway</td>
<td>The server was acting as a gateway or proxy and received an invalid response from the upstream server. This is similar to 502 HTTP Status Code.</td>
</tr>
<tr>
<td><code>1015</code></td>
<td>TLS Handshake</td>
<td>Reserved. Indicates that the connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).</td>
</tr>
<tr>
<td><code>1016</code>–<code>1999</code></td>
<td> </td>
<td>Reserved for future use by the WebSocket standard.</td>
</tr>
<tr>
<td><code>2000</code>–<code>2999</code></td>
<td> </td>
<td>Reserved for use by WebSocket extensions.</td>
</tr>
<tr>
<td><code>3000</code>–<code>3999</code></td>
<td> </td>
<td>Available for use by libraries and frameworks. May not be used by applications. Available for registration at the IANA via first-come, first-serve.</td>
</tr>
<tr>
<td><code>4000</code>–<code>4999</code></td>
<td> </td>
<td>Available for use by applications.</td>
</tr>
Returns a DOMString indicating the reason the server closed the connection. This is specific to the particular server and sub-protocol.
Returns a Boolean that Indicates whether or not the connection was cleanly closed.
Inherited Variables
Defined by Event
A Boolean indicating whether the event bubbles up through the DOM or not.
A historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event.
A Boolean indicating whether the event is cancelable.
A Boolean value indicating whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.
A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent; it's possible this has been changed along the way through retargeting.
Indicates whether or not event.preventDefault() has been called on the event.
Indicates which phase of the event flow is being processed.
The explicit original target of the event (Mozilla-specific).
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent).
The original target of the event, before any retargetings (Mozilla-specific).
A historical property introduced by Internet Explorer and eventually adopted into the DOM specification in order to ensure existing sites continue to work. Ideally, you should try to use Event.preventDefault() and Event.defaultPrevented instead, but you can use returnValue if you choose to do so.
A reference to the target to which the event was originally dispatched.
The time at which the event was created (in milliseconds). By specification, this value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this to be a DOMHighResTimeStamp instead.
The name of the event (case-insensitive).
Inherited Methods
Defined by Event
Returns the event’s path (objects on which listeners will be invoked). This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
@:value({ cancelable : false, bubbles : false })initEvent(type:String, bubbles:Bool = false, cancelable:Bool = false):Void
Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.
Cancels the event (if it is cancelable).
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
Stops the propagation of events further along in the DOM.