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: название в реестре, значение и обычные причины.

КодНазваниеЧто означаетПо сети
1000Normal ClosureСоединение закрылось так, как задумано. Обе стороны закончили работу.
  • Ваш код вызвал close(1000), и другая сторона ответила закрытием.
  • Сервер закончил работу и закрыл соединение с кодом 1000.
  • Осторожно: close() без аргументов не отправляет код вообще, и тогда в событии обычно оказывается 1005.
да
1001Going AwayОдна из сторон завершает работу: страница выгружается или сервер останавливается.
  • Перезагрузка страницы или переход на другую.
  • Плановый перезапуск или выкатка на сервере.
  • Балансировщик вывел экземпляр из пула.
да
1002Protocol ErrorКадр нарушил протокол WebSocket. Дальше читать поток нельзя, поэтому соединение закрывают.
  • Клиент отправил кадр без маскирования. RFC 6455 требует маскировать каждый кадр клиента.
  • Выставлены RSV-биты, хотя расширение не согласовано.
  • Сломана фрагментация: продолжение без начала или текстовый кадр в середине цепочки.
  • Кадры переписал кто-то посередине, обычно прокси, который не понимает Upgrade.
да
1003Unsupported DataСторона понимает тип данных, но не принимает его. Например, сервер работает только с текстом, а пришли двоичные данные.
  • Клиент отправил ArrayBuffer или Blob туда, где сервер ждёт текст.
  • Сервер отправил двоичный кадр клиенту, который читает только текст.
  • После выкатки одна сторона начала отправлять двоичные кадры, а вторая читать их так и не умеет.
да
1004ReservedЗарезервирован, значение ему не назначено. В старых черновиках он означал «кадр слишком большой», сейчас эту роль исполняет 1009.
  • Если вы видите 1004, его придумала библиотека.
  • Браузер его тоже не отправит: close(1004) бросает исключение.
нет
1005No Status ReceivedClose-кадр пришёл, но без кода статуса. API подставляет 1005, чтобы поле не осталось пустым.
  • Другая сторона вызвала close() без аргументов, и Close-кадр ушёл без кода.
  • Библиотека на другой стороне не умеет ставить код.
  • Это не сбой сети: рукопожатие закрытия завершилось, поэтому wasClean здесь true, а у 1006 false.
нет
1006Abnormal ClosureClose-кадра не было, соединение просто пропало. О причине код не говорит ничего.
  • Прокси, балансировщик или nginx закрыл простаивающее соединение по таймауту.
  • Процесс на сервере упал или его убили до того, как он успел отправить Close-кадр.
  • Сеть сменилась или пропала: Wi-Fi на мобильный интернет, туннель, уснувший ноутбук.
  • Антивирус, VPN или корпоративный прокси разорвал соединение, которого не понял.
  • Рукопожатие не завершилось: сервер ответил не 101, а браузер всё равно сообщает 1006.
нет
1007Invalid Frame Payload DataДанные не соответствуют типу кадра. Чаще всего в текстовом кадре лежит не UTF‑8.
  • Байты собрали вне UTF‑8: например, строку нарезали по символам, а не по байтам.
  • Двоичные данные отправили в текстовом кадре.
  • Многобайтовый символ разрезало на границе фрагмента.
да
1008Policy ViolationСообщение нарушило правило приложения, и более точного кода для него нет. Это общее «так нельзя».
  • Не прошла аутентификация или истёк токен.
  • Сработало ограничение по частоте.
  • Клиент попросил то, на что у него нет прав.
  • Сервер выбирает 1008 вместо 1003 или 1009, чтобы не говорить, что именно ему не понравилось.
да
1009Message Too BigСообщение больше, чем другая сторона готова обработать.
  • Ограничение на размер сообщения в библиотеке сервера. Проверьте её значение по умолчанию, они сильно различаются.
  • В сокет отправили файл целиком вместо передачи по частям.
  • Ограничение буфера в прокси перед сервером.
да
1010Mandatory ExtensionКлиент попросил расширение, сервер его не согласовал, и клиент закрывает соединение. Этот код отправляет только клиент: сервер вместо этого обрывает рукопожатие.
  • Клиенту нужен permessage-deflate, а сервер его не включил.
  • Сервер согласовал расширение с параметрами, которые клиент не принимает.
да
1011Internal ErrorСервер столкнулся с непредвиденным условием и не может выполнить запрос. Это аналог 500 в HTTP.
  • Необработанное исключение в обработчике сообщения.
  • Отвалилась база или очередь, от которой зависит обработчик.
  • Сервер закрывает соединение, потому что его состояние перестало сходиться.
да
1012Service RestartСервер перезапускается. Переподключитесь, но сначала подождите.
  • Плановая выкатка или перезапуск процесса.
  • Смена конфигурации, которая требует перезапуска.
да
1013Try Again LaterСервер не может принять соединение прямо сейчас: он перегружен или ограничивает подключения.
  • Соединений больше, чем сервер готов обслуживать.
  • Ограничение частоты подключений с одного адреса.
  • Намеренная разгрузка: сервис отключает часть клиентов, чтобы выдержать нагрузку.
да
1014Bad GatewayШлюз или прокси получил недопустимый ответ от сервера за ним. Это аналог 502 в HTTP.
  • Прокси не смог дотянуться до приложения.
  • Приложение ответило так, что прокси не смог передать это дальше.
да
1015TLS HandshakeРукопожатие TLS не удалось. Браузеры этот код не используют: они сообщают 1006.
  • Сертификату никто не доверяет: самоподписанный, просроченный или выданный центром, которого нет в хранилище.
  • Имя в сертификате не совпадает с адресом, к которому подключаются.
  • Нет общей версии TLS или общего набора шифров.
  • Посередине стоит прокси, который подменяет сертификат, а его корневой сертификат не установлен.
нет

Диапазоны

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