Spec-Zone.ru › Web APIs

WebSocket: событие закрытия

Базовая Широко поддерживается

Эта функция хорошо зарекомендовала себя и работает на многих устройствах и версиях браузеров. Она доступна в браузерах с июля 2015 года.

  • Узнать больше
  • Полная совместимость
  • Отправить отзыв

Примечание: Эта функция доступна в Web Workers.

Событие close срабатывает при закрытии соединения с WebSocket.

Синтаксис

Используйте имя события в методах, таких как addEventListener(), или задайте свойство обработчика событий.

addEventListener("close", (event) => {});

onclose = (event) => {};

Тип события

Объект CloseEvent. Наследуется от Event.

Событие CloseEvent

Свойства события

Помимо перечисленных ниже свойств, доступны свойства из родительского интерфейса Event.

code Только для чтения

Возвращает unsigned short, содержащий код закрытия, отправленный сервером.

reason Только для чтения

Возвращает строку, указывающую причину закрытия соединения сервером. Она специфична для конкретного сервера и подпротокола.

wasClean Только для чтения

Возвращает логическое значение, указывающее, было ли соединение закрыто корректно.

Примеры

Возможно, вам нужно узнать, когда соединение было закрыто, чтобы обновить пользовательский интерфейс или, возможно, сохранить данные о закрытом соединении. Учитывая, что у вас есть переменная exampleSocket, которая ссылается на открытое WebSocket, этот обработчик будет обрабатывать ситуацию, когда сокет был закрыт.

exampleSocket.addEventListener("close", (event) => {
  console.log("The connection has been closed successfully.");
});

Вы можете выполнить те же действия, используя свойство обработчика событий, как показано ниже:

exampleSocket.onclose = (event) => {
  console.log("The connection has been closed successfully.");
};

Спецификации

Спецификация
WebSockets
# dom-websocket-onclose

Совместимость с браузерами

Рабочие столы Мобильные устройства
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari на IOS Samsung Internet WebView Android
close_event 5 12 7 12.1 5 18 7 12.1 4.2 1.0 ≤37

См. также

  • WebSocket: событие ошибки
  • WebSocket: событие сообщения
  • WebSocket: событие открытия
  • Создание приложений-клиентов WebSocket

© 2005–2024 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close_event

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API