CompositeSubscription class
Acts as a container for multiple subscriptions that can be canceled at once e.g. view subscriptions in Flutter that need to be canceled on view disposal
Can be cleared or disposed. When disposed, cannot be used again.
Example
// init your subscriptions composite.add(stream1.listen(listener1)) ..add(stream2.listen(listener1)) ..add(stream3.listen(listener1));
// clear them all at once composite.clear();
Constructors
Properties
- allPaused → bool
-
Whether all managed StreamSubscriptions are currently paused.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isDisposed → bool
-
Checks if this composite is disposed. If it is, the composite can't be used again
and will throw an error if you try to add more subscriptions to it.
no setter
- isEmpty → bool
-
Checks if there currently are no StreamSubscriptions added
no setter
- isNotEmpty → bool
-
Checks if there currently are StreamSubscriptions added
no setter
- length → int
-
Returns the total amount of currently added StreamSubscriptions
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
add<
T> (StreamSubscription< T> subscription) → StreamSubscription<T> - Adds new subscription to this composite.
-
clear(
) → void - Cancels all subscriptions added to this composite. Clears subscriptions collection.
-
dispose(
) → void - Cancels all subscriptions added to this composite. Disposes this.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pauseAll(
[Future< void> ? resumeSignal]) → void - Pauses all subscriptions added to this composite.
-
remove(
StreamSubscription subscription) → void - Cancels subscription and removes it from this composite.
-
resumeAll(
) → void - Resumes all subscriptions added to this composite.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited