W3cubDocs

/Dart 2

StreamController<T> class

A controller with the stream it controls.

This controller allows sending data, error and done events on its stream. This class can be used to create a simple stream that others can listen on, and to push events to that stream.

It's possible to check whether the stream is paused or not, and whether it has subscribers or not, as well as getting a callback when either of these change.

Implements
Implemented by

Constructors

StreamController({void onListen(), void onPause(), void onResume(), dynamic onCancel(), bool sync: false })
factory
A controller with a stream that supports only one single subscriber. [...]
StreamController.broadcast({void onListen(), void onCancel(), bool sync: false })
factory
A controller where stream can be listened to more than once. [...]

Properties

hasListenerbool
read-only
Whether there is a subscriber on the Stream.
isClosedbool
read-only
Whether the stream controller is closed for adding more events. [...]
isPausedbool
read-only
Whether the subscription would need to buffer events. [...]
onCancelControllerCancelCallback
read / write
The callback which is called when the stream is canceled. [...]
onListenControllerCallback
read / write
The callback which is called when the stream is listened to. [...]
onPauseControllerCallback
read / write
The callback which is called when the stream is paused. [...]
onResumeControllerCallback
read / write
The callback which is called when the stream is resumed. [...]
sinkStreamSink<T>
read-only
Returns a view of this object that only exposes the StreamSink interface.
streamStream<T>
read-only
The stream that this controller is controlling.
doneFuture
read-only, inherited
Return a future which is completed when the StreamSink is finished. [...]
hashCodeint
read-only, inherited
The hash code for this object. [...]
runtimeTypeType
read-only, inherited
A representation of the runtime type of the object.

Methods

add(T event) → void
Sends a data event. [...]
addError(Object error, [ StackTrace stackTrace ]) → void
Sends or enqueues an error event. [...]
addStream(Stream<T> source, { bool cancelOnError }) → Future
Receives events from source and puts them into this controller's stream. [...]
close() → Future
Closes the stream. [...]
noSuchMethod(Invocation invocation) → dynamic
inherited
Invoked when a non-existent method or property is accessed. [...]
toString() → String
inherited
Returns a string representation of this object.

Operators

operator ==(dynamic other) → bool
inherited
The equality operator. [...]

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dartlang.org/stable/2.0.0/dart-async/StreamController-class.html