Подписка на поток< T>
Подписка на события из потока.
При подписке на поток с помощью Stream.listen возвращается объект StreamSubscription.
Подписка предоставляет события слушателю и хранит обратные вызовы, используемые для обработки событий. Подписка также может использоваться для отписки от событий или временного приостановления событий из потока.
Пример:
final stream = Stream.periodic(const Duration(seconds: 1), (i) => i * i)
.take(10);
final subscription = stream.listen(print); // A StreamSubscription<int>. Для приостановки подписки используйте pause.
// Do some work. subscription.pause(); print(subscription.isPaused); // true
Для возобновления после приостановки используйте resume.
// Do some work. subscription.resume(); print(subscription.isPaused); // false
Для отмены подписки используйте cancel.
// Do some work. subscription.cancel();
Конструкторы
- StreamSubscription()
Свойства
- hashCode → int только для чтения, унаследованное
- Хэш-код этого объекта.
- isPaused → bool только для чтения
- Является ли StreamSubscription в настоящее время приостановленным.
- runtimeType → Type только для чтения, унаследованное
- Представление типа объекта во время выполнения.
Методы
- asFuture<
E>( [E? futureValue]) → Future< E> - Возвращает будущее, которое обрабатывает обратные вызовы onDone и onError.
- cancel(
) → Future< void> - Отменяет эту подписку.
- noSuchMethod(
Invocation invocation) → dynamic унаследованное - Вызывается при доступе к несуществующему методу или свойству.
- onData(
void handleData(T data)?) → void - Заменяет обработчик событий данных этой подписки.
- onDone(
void handleDone()?) → void - Заменяет обработчик события завершения этой подписки.
- onError(
Function? handleError) → void - Заменяет обработчик событий об ошибке этой подписки.
- pause(
[Future< void>? resumeSignal]) → void - Запрашивает приостановку событий потока до дальнейших указаний.
- resume(
) → void - Возобновляет после приостановки.
- toString(
) → String унаследованное - Строковое представление этого объекта.
Операторы
- operator ==(
Object other) → bool унаследованное - Оператор равенства.
© 2012 the Dart project authors
Licensed under the BSD 3-Clause "New" or "Revised" License.
https://api.dart.dev/stable/2.18.5/dart-async/StreamSubscription-class.html