Close-коды WebSocket
Введите код из события close. Получите его значение, документ, который его определяет, и обычные причины.
Всё считается в вашем браузере
Спецификация: RFC 6455 § 7.4IANA WebSocket Close Code Number Registry
Любое число. Close-коды занимают диапазон от 1000 до 4999.
Все коды закрытия WebSocket (close codes) от 1000 до 1015
Close-код ещё называют кодом закрытия или статус-кодом WebSocket-соединения (close code, status code). Ниже все коды от 1000 до 1015: название в реестре, значение и обычные причины.
| Код | Название | Что означает | По сети |
|---|---|---|---|
| 1000 | Normal Closure | Соединение закрылось так, как задумано. Обе стороны закончили работу.
| да |
| 1001 | Going Away | Одна из сторон завершает работу: страница выгружается или сервер останавливается.
| да |
| 1002 | Protocol Error | Кадр нарушил протокол WebSocket. Дальше читать поток нельзя, поэтому соединение закрывают.
| да |
| 1003 | Unsupported Data | Сторона понимает тип данных, но не принимает его. Например, сервер работает только с текстом, а пришли двоичные данные.
| да |
| 1004 | Reserved | Зарезервирован, значение ему не назначено. В старых черновиках он означал «кадр слишком большой», сейчас эту роль исполняет 1009.
| нет |
| 1005 | No Status Received | Close-кадр пришёл, но без кода статуса. API подставляет 1005, чтобы поле не осталось пустым.
| нет |
| 1006 | Abnormal Closure | Close-кадра не было, соединение просто пропало. О причине код не говорит ничего.
| нет |
| 1007 | Invalid Frame Payload Data | Данные не соответствуют типу кадра. Чаще всего в текстовом кадре лежит не UTF‑8.
| да |
| 1008 | Policy Violation | Сообщение нарушило правило приложения, и более точного кода для него нет. Это общее «так нельзя».
| да |
| 1009 | Message Too Big | Сообщение больше, чем другая сторона готова обработать.
| да |
| 1010 | Mandatory Extension | Клиент попросил расширение, сервер его не согласовал, и клиент закрывает соединение. Этот код отправляет только клиент: сервер вместо этого обрывает рукопожатие.
| да |
| 1011 | Internal Error | Сервер столкнулся с непредвиденным условием и не может выполнить запрос. Это аналог 500 в HTTP.
| да |
| 1012 | Service Restart | Сервер перезапускается. Переподключитесь, но сначала подождите.
| да |
| 1013 | Try Again Later | Сервер не может принять соединение прямо сейчас: он перегружен или ограничивает подключения.
| да |
| 1014 | Bad Gateway | Шлюз или прокси получил недопустимый ответ от сервера за ним. Это аналог 502 в HTTP.
| да |
| 1015 | TLS Handshake | Рукопожатие TLS не удалось. Браузеры этот код не используют: они сообщают 1006.
| нет |
Диапазоны
- 1000–2999
- Принадлежит протоколу и реестру IANA. Своё сюда писать нельзя, а браузер откажется отправить отсюда любой код, кроме 1000.
- 3000–3999
- Библиотеки, фреймворки и приложения, с регистрацией в IANA. Значение смотрите в документации того, кто прислал код.
- 4000–4999
- Частное использование. Значение задаёте вы, регистрировать не нужно.
Вопросы о кодах закрытия WebSocket
Что такое Close-код WebSocket?
Это число от 1000 до 4999, которое сообщает, почему закрылось соединение. Сторона, которая закрывает соединение, пишет код в первые два байта Close-кадра и может добавить причину: до 123 байт текста. В браузере код приходит в событии close как event.code, рядом с event.reason и event.wasClean. В библиотеках и документации его называют ещё status code и error code.
Что означает код 1000?
Обычное закрытие. Одна сторона закончила работу и отправила Close-кадр с кодом 1000, вторая ответила тем же. Это не ошибка: исправлять нечего, переподключаться не нужно.
Почему WebSocket отключается сам?
Чаще всего соединение рвёт кто-то между клиентом и сервером, когда по нему долго ничего не идёт. nginx по умолчанию делает это через 60 секунд (proxy_read_timeout), у балансировщиков свой предел. Браузер в таком случае сообщает 1006, а обрывы повторяются через одинаковое время. Отправляйте ping или короткое сообщение чаще, чем истекает самый короткий таймаут на пути. Остальные коды называют причину прямо: 1001 значит, что сервер останавливается или страница выгружается, 1011 сообщает об ошибке на сервере.
Чем 1005 отличается от 1006?
При 1005 Close-кадр пришёл, но кода в нём не было. Рукопожатие закрытия завершилось, и wasClean равен true. При 1006 Close-кадра не было совсем: соединение оборвалось, и wasClean равен false. По сети не передаётся ни тот, ни другой код: оба подставляет API на вашей стороне.
Какие коды можно отправлять из своего кода?
В браузере close() принимает 1000 или число от 3000 до 4999. Любой другой код вызывает InvalidAccessError, а причина длиннее 123 байт вызывает SyntaxError. Для собственных кодов берите диапазон 4000–4999. Серверная библиотека разрешает отправить и другие коды из списка, но 1004, 1005, 1006 и 1015 ставить в Close-кадр нельзя.
После каких кодов клиенту стоит переподключаться?
После 1001, 1006, 1012, 1013 и 1014 переподключайтесь и увеличивайте паузу с каждой попыткой. После 1011 хватит нескольких попыток. После 1000 переподключаться не нужно: соединение закрыли намеренно. После 1002, 1003, 1007, 1008, 1009 и 1010 тот же клиент получит тот же отказ, поэтому сначала устраните причину.
101 — это Close-код?
Нет. 101 Switching Protocols — это код ответа HTTP. Сервер отправляет его один раз, в ответ на запрос с Upgrade, и он означает, что соединение открылось. Close-коды появляются в конце соединения. Если сервер ответил на рукопожатие не 101, браузер сообщает 1006 и не показывает скрипту код HTTP.
Смотрите также
Хотите увидеть больше?
Посмотреть в Solpuga