dart:html

Класс WebSocket

Используйте интерфейс WebSocket для подключения к WebSocket, а также для отправки и получения данных через это соединение.

Чтобы использовать WebSocket в веб-приложении, сначала создайте объект WebSocket, передав URL-адрес WebSocket в качестве аргумента конструктору.

var webSocket = new WebSocket('ws://127.0.0.1:1337/ws');

Для отправки данных через WebSocket используйте метод send.

if (webSocket != null && webSocket.readyState == WebSocket.OPEN) {
  webSocket.send(data);
} else {
  print('WebSocket not connected, message $data not sent');
}

Для получения данных через WebSocket зарегистрируйте обработчик событий сообщений.

webSocket.onMessage.listen((MessageEvent e) {
  receivedData(e.data);
});

Обработчик события сообщения получает объект MessageEvent в качестве единственного аргумента. Также можно определить обработчики событий открытия, закрытия и ошибки, как указано в описании событий Event.

Дополнительные сведения см. в разделе WebSockets обзора библиотек и в руководстве HTML5Rocks.com Введение в WebSockets.

Наследование

• Object
• EventTarget
• WebSocket

Аннотации

• @SupportedBrowser(SupportedBrowser.CHROME)
• @SupportedBrowser(SupportedBrowser.FIREFOX)
• @SupportedBrowser(SupportedBrowser.IE, '10')
• @SupportedBrowser(SupportedBrowser.SAFARI)
• @Unstable()
• @Native("WebSocket")

Конструкторы

WebSocket(String url, [Object? protocols])

фабричный

Свойства

binaryType ↔ String?

чтение / запись

bufferedAmount → int?

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

extensions → String?

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

hashCode → int

только для чтения, унаследовано

Хеш-код этого объекта.

on → Events

только для чтения, унаследовано

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

onClose → Stream<CloseEvent>

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

Поток событий close, обрабатываемых этим объектом WebSocket.

onError → Stream<Event>

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

Поток событий error, обрабатываемых этим объектом WebSocket.

onMessage → Stream<MessageEvent>

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

Поток событий message, обрабатываемых этим объектом WebSocket.

onOpen → Stream<Event>

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

Поток событий open, обрабатываемых этим объектом WebSocket.

protocol → String?

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

readyState → int

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

runtimeType → Type

только для чтения, унаследовано

Представление типа объекта во время выполнения.

url → String?

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

Методы

addEventListener(String type, EventListener? listener, [bool? useCapture]) → void

унаследовано

close([int? code, String? reason]) → void

dispatchEvent(Event event) → bool

унаследовано

noSuchMethod(Invocation invocation) → dynamic

унаследовано

Вызывается при обращении к несуществующему методу или свойству.

removeEventListener(String type, EventListener? listener, [bool? useCapture]) → void

унаследовано

send(dynamic data) → void

Передаёт данные серверу через это соединение.

sendBlob(Blob data) → void

Передаёт данные серверу через это соединение.

sendByteBuffer(ByteBuffer data) → void

Передаёт данные серверу через это соединение.

sendString(String data) → void

Передаёт данные серверу через это соединение.

sendTypedData(TypedData data) → void

Передаёт данные серверу через это соединение.

toString() → String

унаследовано

Строковое представление этого объекта.

Операторы

operator ==(Object other) → bool

унаследовано

Оператор равенства.

Статические свойства

supported → bool

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

Проверяет, поддерживается ли этот тип на текущей платформе.

Константы

CLOSED → const int

3

closeEvent → const EventStreamProvider<CloseEvent>

Статическая фабрика, предназначенная для предоставления событий close обработчикам событий, которые не обязательно являются экземплярами WebSocket.

const EventStreamProvider<CloseEvent>('close')

CLOSING → const int

2

CONNECTING → const int

0

errorEvent → const EventStreamProvider<Event>

Статическая фабрика, предназначенная для предоставления событий error обработчикам событий, которые не обязательно являются экземплярами WebSocket.

const EventStreamProvider<Event>('error')

messageEvent → const EventStreamProvider<MessageEvent>

Статическая фабрика, предназначенная для предоставления событий message обработчикам событий, которые не обязательно являются экземплярами WebSocket.

const EventStreamProvider<MessageEvent>('message')

OPEN → const int

1

openEvent → const EventStreamProvider<Event>

Статическая фабрика, предназначенная для предоставления событий open обработчикам событий, которые не обязательно являются экземплярами WebSocket.

const EventStreamProvider<Event>('open')