CloseEvent

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

當 WebSocket 連線關閉時,客戶端會收到一個 CloseEvent,由 WebSocket 物件 onclose 屬性表示的監聽器接收。

屬性

屬性 形態 描述
code unsigned long WebSocket 伺服器給予的連線關閉代碼。「狀態代碼」列有所有可能值。
reason DOMString 表示伺服器關閉連線的原因,這因不同的伺服器與子協定而定。
wasClean boolean 表示連線關閉情況是否乾淨。

狀態代碼

以下列有所有合法的狀態代碼。

狀態代碼 描述
0-999 尚未使用的保留值。
1000 正常關閉,連線成功地達到建立時的目標。
1001 端點去離,伺服器故障或是瀏覽器從開啟連線的頁面離去的情形。
1002 因協定錯誤造成連線被端點消滅。
1003 因端點接收不能處理的資料形態(舉例來說,文字端點收到二進制資料)而消滅連線。
1004 端點收到過大的資料幀而消滅連線。
1005 保留值。表示意外地未給予狀態代碼的情形。
1006 保留值。用以表示在預期收到狀態代碼的情形下不正常(即未送關閉幀)的連線關閉。
1007-1999 保留以作為未來的 WebSocket 標準之用。
2000-2999 保留以作為 WebSocket 擴展之用。
3000-3999 程式庫與框架使用的值,應用程式可不使用。
4000-4999 應用程式使用的值。

參見

瀏覽器兼容

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
CloseEvent
CloseEvent() constructor
code
reason
wasClean

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
See implementation notes.