LimitedStreamController<T> class
A specialized StreamController that limits the no. of elements that can be in the stream.
- Implemented types
Constructors
- LimitedStreamController(int _limit, {void onListen()?, void onCancel()?, bool sync = false})
- Creates a new LimitedStreamController that limits the no. of elements that can be in the queue.
Properties
- done → Future
-
A future which is completed when the stream controller is done
sending events.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListener → bool
-
Whether there is a subscriber on the Stream.
no setteroverride
- isClosed → bool
-
Whether the stream controller is closed for adding more events.
no setteroverride
- isPaused → bool
-
Whether the subscription would need to buffer events.
no setteroverride
- length → int
-
Returns the no. of elements waiting in the stream.
no setter
- onCancel ↔ ControllerCancelCallback?
-
The callback which is called when the stream is canceled.
getter/setter pairoverride
- onListen ↔ ControllerCallback?
-
The callback which is called when the stream is listened to.
getter/setter pairoverride
- onPause ↔ ControllerCallback?
-
The callback which is called when the stream is paused.
getter/setter pairoverride
- onResume ↔ ControllerCallback?
-
The callback which is called when the stream is resumed.
getter/setter pairoverride
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sink
→ StreamSink<
T> -
Returns a view of this object that only exposes the StreamSink interface.
no setteroverride
-
stream
→ Stream<
T> -
The stream that this controller is controlling.
no setteroverride
Methods
-
add(
T event) → void -
Sends a data
event.override -
addError(
Object error, [StackTrace? stackTrace]) → void -
Sends or enqueues an error event.
override
-
addStream(
Stream< T> source, {bool? cancelOnError = true}) → Future<bool> -
Receives events from
sourceand puts them into this controller's stream.override -
asyncAdd(
T event) → Future< void> - Add an event to the stream. If the stream is full then this method will wait until there is room.
-
close(
) → Future -
Closes the stream.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited