WebSocket: phương thức close()

Cú pháp

close()
close(code)
close(code, reason)

Tham số

code Optional

Một giá trị số nguyên WebSocket connection close code cho biết lý do đóng:

• Nếu không chỉ định, mã đóng của kết nối sẽ được đặt tự động: là 1000 cho một lần đóng bình thường, hoặc là một giá trị chuẩn khác trong khoảng 1001-1015 để chỉ lý do thực tế khiến kết nối bị đóng.
• Nếu được chỉ định, giá trị của tham số code sẽ ghi đè thiết lập tự động của mã đóng cho kết nối và thay vào đó đặt một mã tùy chỉnh. Giá trị phải là một số nguyên: hoặc 1000, hoặc một mã tùy chỉnh do bạn chọn trong khoảng 3000-4999. Nếu bạn chỉ định giá trị code, bạn cũng nên chỉ định giá trị reason.

reason Optional

Một chuỗi cung cấp WebSocket connection close reason tùy chỉnh (một lời giải thích ngắn gọn, dễ hiểu bằng văn bản tự nhiên cho việc đóng kết nối). Giá trị này không được dài quá 123 byte (khi mã hóa UTF-8).

Note: Vì UTF-8 dùng hai đến bốn byte để mã hóa bất kỳ ký tự nào không phải ASCII, một giá trị reason dài 123 ký tự nhưng chứa ký tự không phải ASCII sẽ vượt quá giới hạn 123 byte.

Nếu bạn chỉ định giá trị reason, bạn cũng nên chỉ định giá trị code.

Giá trị trả về

Không có (undefined).

Ngoại lệ

InvalidAccessError DOMException

Được ném ra nếu code không phải là số nguyên bằng 1000 hoặc là số nguyên trong khoảng 3000 đến 4999.

SyntaxError DOMException

Được ném ra nếu giá trị reason sau khi mã hóa UTF-8 dài hơn 123 byte.

Thông số kỹ thuật

Tương thích trình duyệt

Xem thêm

• RFC 6455 (đặc tả giao thức WebSocket)