JavaScript метод WebSocket.send()

Определение и применение

JavaScript метод send() объекта WebSocket позволяет передать данные на сервер через WebSocket соединение.

Поддержка браузерами

Спецификация: websockets.spec.whatwg

Поддерживается во всех основных браузерах с 2015 года.

Показать браузеры
Совместимостьapi.WebSocket.send
ВозможностьКомпьютерыМобильные
ChromeEdgeFirefoxOperaSafariChrome AndroidFirefox for AndroidOpera AndroidSafari on iOSSamsung BrowserWebView AndroidWebView on iOS
send✓5✓12✓18✓12.1✓5✓18✓18✓12.1✓4.2✓1.0✓4.4✓4.2

поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31

JavaScript синтаксис

JavaScript
socket.send(data);

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

WebSockets Standard.

Значения параметров

Параметры WebSocket.send()
Параметр Описание
data Данные, предназначенные для отправки на сервер. Они могут быть одним из следующих типов:
  • USVString - Текстовая строка. Строка добавляется в буфер в формате UTF-8, а значение свойства bufferedAmount (число байтов данных в очереди) увеличивается на количество байтов, необходимых для представления строки UTF-8.
  • ArrayBuffer - Базовые двоичные данные, используемые типизированными массивами, его содержимое двоичных данных помещается в очередь в буфер, увеличивая значение свойства bufferedAmount на необходимое количество байтов.
  • Blob - объект Blob (представляет собой файлоподобный объект неизменяемых необработанных данных). Значение свойства bufferedAmount увеличивается на размер байта этих необработанных данных.
  • ArrayBufferView - любой типизированный объект массива JavaScript в виде двоичного фрейма, его содержимое двоичных данных помещается в очередь в буфер, увеличивая значение свойства bufferedAmount на необходимое количество байтов.

Исключения

Исключения WebSocket.send()
Тип исключения Описание
InvalidStateError Возникает, если соединение находится в состоянии CONNECTING. В состояниях CLOSING и CLOSED исключения нет: данные отбрасываются, а bufferedAmount увеличивается.

Пример использования

Для запуска нужен WebSocket-сервер по адресу ws://localhost:8080. Запустите свой сервер или замените адрес в коде; обычного HTTP-сервера недостаточно. Это листинг для отдельной страницы, соединение на сайте не открывается.

JavaScript
// создаем WebSocket подключение
const socket = new WebSocket("ws://localhost:8080");

// устанавливаем обработчик событий, вызываемый при открытии соединения
socket.onopen = function(event) {
    socket.send("соединение с сервером установлено");
    // отправляем определенные данные в формате JSON
    const data = { type: "message", text: "Привет" };
    socket.send(JSON.stringify(data));
};
// устанавливаем обработчик событий, вызываемый при получении сообщения от сервера
socket.onmessage = function(event) {
    console.log("сообщение от сервера получено", event.data);
}
// устанавливаем обработчик событий, вызываемый при ошибке
socket.onerror = function(event) {
  console.error("Ошибка WebSocket");
  socket.close(); // закрываем подключение к серверу
}
// устанавливаем обработчик событий, вызываемый при закрытии соединения
socket.onclose = function(event) {
  console.log("Соединение с сервером завершено");
}