A subscription on events from a Stream.

When you listen on a Stream using Stream.listen, a StreamSubscription object is returned.

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.




isPaused bool

Returns true if the StreamSubscription is paused.

hashCode int

The hash code for this object.

read-only, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited


operator ==(other) bool

The equality operator.



asFuture<E>([E futureValue ]) Future<E>

Returns a future that handles the onDone and onError callbacks.

cancel() Future

Cancels this subscription.

onData(void handleData(T data)) → void

Set or override the data event handler of this subscription.

onDone(void handleDone()) → void

Set or override the done event handler of this subscription.

onError(Function handleError) → void

Set or override the error event handler of this subscription.

pause([Future resumeSignal ]) → void

Request that the stream pauses events until further notice.

resume() → void

Resume after a pause.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

toString() String

Returns a string representation of this object.