WebSocketStream: phương thức close()
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Note: This feature is available in Web Workers.
Phương thức close() của giao diện WebSocketStream đóng kết nối WebSocket. Phương thức này tùy chọn nhận một đối tượng chứa mã đóng và/hoặc lý do tùy chỉnh để chỉ ra vì sao kết nối bị đóng.
Cú pháp
close()
close(options)
Tham số
optionsOptional-
Một đối tượng tùy chọn chứa các thuộc tính sau:
closeCodeOptional-
Một số biểu thị mã đóng (xem danh sách đầy đủ
CloseEventstatus codes). reasonOptional-
Một chuỗi biểu thị mô tả dễ đọc về lý do socket connection bị đóng. Độ dài tối đa cho chuỗi
reasonlà 123 byte. Chuỗi sẽ được mã hóa tự động thành UTF-8 khi hàm được gọi.
Note: Tùy theo cấu hình máy chủ và mã trạng thái bạn dùng, máy chủ có thể bỏ qua mã tùy chỉnh và thay bằng một mã hợp lệ phù hợp với lý do đóng. Các mã hợp lệ là 1000, và mọi mã trong khoảng 3000 đến 4999, bao gồm cả hai đầu.
Giá trị trả về
Không có (undefined).
Ngoại lệ
SyntaxErrorDOMException-
Được ném ra nếu
reasonđược cung cấp dài hơn độ dài tối đa cho phép là 123 byte.
Ví dụ
const wsURL = "wss://127.0.0.1/";
const wss = new WebSocketStream(wsURL);
setTimeout(() => {
wss.close({
closeCode: 1000,
reason: "That's all folks",
});
}, 10000);
Thông số kỹ thuật
Hiện chưa thuộc bất kỳ đặc tả nào. Xem https://github.com/whatwg/websockets/pull/48 để theo dõi tiến trình chuẩn hóa.
Tương thích trình duyệt
Xem thêm
- WebSocketStream: tích hợp streams với WebSocket API, developer.chrome.com (2020)