dart:io

Класс WebSocket

Двусторонний объект HTTP-связи для клиентских или серверных приложений.

Поток отображает полученные сообщения. Текстовое сообщение будет иметь тип String, а двоичное сообщение — тип List<int>.

Реализованные типы

• Поток
• Поток-приемник

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

WebSocket()

WebSocket.fromUpgradedSocket(Сокет socket, {Строка? protocol, Булево? serverSide, ПараметрыСжатия compression = CompressionOptions.compressionDefault})

factory

Создает WebSocket из уже обновленного сокета.

Свойства

closeCode → Целое число?

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

Код закрытия, установленный при закрытии соединения WebSocket. Если код закрытия недоступен, это свойство будет null

closeReason → Строка?

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

Причина закрытия, установленная при закрытии соединения WebSocket. Если причина закрытия недоступна, это свойство будет null

done → Будущее

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

Возвращает будущее, которое выполняется, когда Поток-приемник завершен.

extensions → Строка

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

Свойство extensions изначально пустая строка. После создания соединения WebSocket эта строка отражает используемые сервером расширения.

first → Будущее

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

Первый элемент этого потока.

hashCode → Целое число

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

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

isBroadcast → Булево

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

Является ли этот поток потоком широковещательной передачи.

isEmpty → Будущее<Булево>

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

Содержит ли этот поток какие-либо элементы.

last → Будущее

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

Последний элемент этого потока.

length → Будущее<Целое число>

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

Количество элементов в этом потоке.

pingInterval ↔ Длительность?

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

Интервал между сигналами ping.

protocol → Строка?

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

Свойство protocol изначально пустая строка. После установления соединения WebSocket значение является выбранным сервером подпротоколом. Если подпротокол не согласован, значение останется null.

readyState → Целое число

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

Возвращает текущее состояние соединения.

runtimeType → Тип

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

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

single → Будущее

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

Единственный элемент этого потока.

Методы

add(динамические данные) → void

переопределение

Отправляет данные по подключению WebSocket. Данные в data должны быть либо String, либо List<int>, содержащим байты.

addError(Объект ошибка, [StackTrace? стекСледов]) → void

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

Добавляет error в поток.

addStream(Поток поток) → Будущее

переопределение

Отправляет данные из потока по подключению WebSocket. Каждый элемент данных из stream будет отправлен как отдельный кадр WebSocket. Данные из stream должны быть либо String, либо List<int>, содержащими байты.

addUtf8Text(Список<int> байты) → void

Отправляет текстовое сообщение с текстом, представленным bytes.

any(bool тест(динамический элемент)) → Будущее<bool>

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

Проверяет, принимает ли test любой элемент, предоставляемый этим потоком.

asBroadcastStream({void onListen(ПодпискаНаПоток подписка)?, void onCancel(ПодпискаНаПоток подписка)?}) → Поток

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

Возвращает поток с множественной подпиской, который генерирует те же события, что и этот.

asyncExpand<E>(Поток<E>? конвертировать(динамический элемент)) → Поток<E>

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

Преобразует каждый элемент в последовательность асинхронных событий.

asyncMap<E>(FutureOr<E> конвертировать(динамический элемент)) → Поток<E>

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

Создает новый поток, в котором каждое событие данных этого потока асинхронно сопоставляется с новым событием.

cast<R>() → Поток<R>

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

Адаптирует этот поток для работы как Stream<R>.

close([int? код, Строка? причина]) → Будущее

переопределение

Закрывает соединение WebSocket. Установите необязательные аргументы code и reason, чтобы отправить информацию о закрытии удаленному узлу. Если они опущены, узел увидит код WebSocketStatus.noStatusReceived без причины.

contains(Объект? искомое) → Будущее<bool>

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

Возвращает, происходит ли needle в элементах, предоставляемых этим потоком.

distinct([bool equals(динамический предыдущий, динамический следующий)?]) → Поток

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

Пропускает события данных, если они равны предыдущему событию данных.

drain<E>([E? будущееЗначение]) → Будущее<E>

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

Отбрасывает все данные из этого потока, но сигнализирует, когда он завершен или произошла ошибка.

elementAt(int индекс) → Будущее

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

Возвращает значение index-го события данных этого потока.

every(bool тест(динамический элемент)) → Будущее<bool>

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

Проверяет, принимает ли test все элементы, предоставляемые этим потоком.

expand<S>(Итерируемый<S> конвертировать(динамический элемент)) → Поток<S>

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

Преобразует каждый элемент этого потока в последовательность элементов.

firstWhere(bool тест(динамический элемент), {динамический илиElse()?}) → Будущее

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

Находит первый элемент этого потока, соответствующий test.

fold<S>(S начальноеЗначение, S комбинировать(S предыдущий, динамический элемент)) → Будущее<S>

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

Объединяет последовательность значений, многократно применяя combine.

forEach(void действие(динамический элемент)) → Будущее

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

Выполняет action над каждым элементом этого потока.

handleError(Функция приОбработкеОшибки, {bool тест(динамический ошибка)?}) → Поток

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

Создает оборачивающий поток, который перехватывает некоторые ошибки из этого потока.

join([Строка разделитель = ""]) → Будущее<Строка>

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

Объединяет строковое представление элементов в одну строку.

lastWhere(bool тест(динамический элемент), {динамический илиElse()?}) → Будущее

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

Находит последний элемент в этом потоке, соответствующий test.

listen(void onData(динамический событие)?, {Функция? приОбработкеОшибки, void наВыходе()?, bool? отменитьПриОшибке}) → ПодпискаНаПоток

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

Добавляет подписку на этот поток.

map<S>(S конвертировать(динамический событие)) → Поток<S>

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

Преобразует каждый элемент этого потока в новое событие потока.

noSuchMethod(Вызов вызов) → динамический

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

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

pipe(ПотоковыйПотребитель потокПотребитель) → Будущее

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

Перенаправляет события этого потока в streamConsumer.

reduce(динамический комбинировать(динамический предыдущий, динамический элемент)) → Будущее

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

Объединяет последовательность значений, многократно применяя combine.

singleWhere(bool тест(динамический элемент), {динамический илиElse()?}) → Будущее

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

Находит единственный элемент в этом потоке, соответствующий test.

skip(int количество) → Поток

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

Пропускает первые count события данных из этого потока.

skipWhile(bool тест(динамический элемент)) → Поток

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

Пропускает события данных из этого потока, пока они соответствуют test.

take(int количество) → Поток

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

Предоставляет не более первых count событий данных этого потока.

takeWhile(bool тест(динамический элемент)) → Поток

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

Передает события данных, пока test успешно.

timeout(Duration timeLimit, {void onTimeout(EventSink sink)?}) → Stream

inherited

Создаёт новый поток с теми же событиями, что и этот поток.

toList() → Future<List>

inherited

Собирает все элементы этого потока в List.

toSet() → Future<Set>

inherited

Собирает данные этого потока в Set.

toString() → String

inherited

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

transform<S>(StreamTransformer<dynamic, S> streamTransformer) → Stream<S>

inherited

Применяет streamTransformer к этому потоку.

where(bool test(dynamic event)) → Stream

inherited

Создаёт новый поток из этого потока, отбрасывая некоторые элементы.

Операторы

operator ==(Object other) → bool

inherited

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

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

userAgent ↔ String?

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

Получает пользовательский агент, используемый для подключений WebSocket.

Статические методы

connect(String url, {Iterable<String>? protocols, Map<String, dynamic>? headers, CompressionOptions compression = CompressionOptions.compressionDefault, HttpClient? customClient}) → Future<WebSocket>

Создаёт новое подключение WebSocket. URL, указанный в url, должен использовать схему ws или wss.

Константы

closed → const int

3

closing → const int

2

connecting → const int

Возможные состояния соединения.

0

open → const int

1