EventStreamSubscription<T extends Event> class

A subscription on events from an EventStream.

The subscription provides events to the listener, and holds the callbacks used to handle the events. The subscription can also be used to unsubscribe from the events, or to temporarily pause the events from the stream.

Implemented types

Properties

eventListener EventListener<T>?
no setter
eventStream EventStream<T>
no setter
hashCode int
The hash code for this object.
no setterinherited
isCanceled bool
no setter
isCapturing bool
no setter
isPaused bool
Whether the StreamSubscription is currently paused.
no setteroverride
priority int
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

asFuture<E>([E? futureValue]) Future<E>
Returns a future that handles the onDone and onError callbacks.
override
cancel() Future<void>
Cancels this subscription.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onData(void handleData(T event)?) → void
Replaces the data event handler of this subscription.
override
onDone(void handleDone()?) → void
Replaces the done event handler of this subscription.
override
onError(Function? handleError) → void
Replaces the error event handler of this subscription.
override
pause([Future<void>? resumeSignal]) → void
Requests that the stream pauses events until further notice.
override
resume() → void
Resumes after a pause.
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited