SSEStream class abstract

A specialized Stream that allows event registration.

You can obtain an instance of such a stream via SSEClient.stream. After obtaining it, you should immediatly start to listen on the stream, to prevent data loss on some platforms.

By default, the stream will not emit any events. You have to explicitly register each event type you want to receive via addEventType. You can remove them again via removeEventType. It does not matter, if you call these methods before or after listening to the stream.

Inheritance

Constructors

SSEStream()

Properties

first → Future<ServerSentEvent>
The first element of this stream.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isBroadcast → bool
Whether this stream is a broadcast stream.
no setterinherited
isEmpty → Future<bool>
Whether this stream contains any elements.
no setterinherited
last → Future<ServerSentEvent>
The last element of this stream.
no setterinherited
length → Future<int>
The number of elements in this stream.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Future<ServerSentEvent>
The single element of this stream.
no setterinherited

Methods

addEventType(String event) → void
Adds the given event type to the stream for listening.
any(bool test(ServerSentEvent element)) → Future<bool>
Checks whether test accepts any element provided by this stream.
inherited
asBroadcastStream({void onListen(StreamSubscription<ServerSentEvent> subscription)?, void onCancel(StreamSubscription<ServerSentEvent> subscription)?}) → Stream<ServerSentEvent>
Returns a multi-subscription stream that produces the same events as this.
inherited
asyncExpand<E>(Stream<E>? convert(ServerSentEvent event)) → Stream<E>
Transforms each element into a sequence of asynchronous events.
inherited
asyncMap<E>(FutureOr<E> convert(ServerSentEvent event)) → Stream<E>
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
inherited
cast<R>() → Stream<R>
Adapt this stream to be a Stream<R>.
inherited
contains(Object? needle) → Future<bool>
Returns whether needle occurs in the elements provided by this stream.
inherited
distinct([bool equals(ServerSentEvent previous, ServerSentEvent next)?]) → Stream<ServerSentEvent>
Skips data events if they are equal to the previous data event.
inherited
drain<E>([E? futureValue]) → Future<E>
Discards all data on this stream, but signals when it is done or an error occurred.
inherited
elementAt(int index) → Future<ServerSentEvent>
Returns the value of the indexth data event of this stream.
inherited
every(bool test(ServerSentEvent element)) → Future<bool>
Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(ServerSentEvent element)) → Stream<S>
Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(ServerSentEvent element), {ServerSentEvent orElse()?}) → Future<ServerSentEvent>
Finds the first element of this stream matching test.
inherited
fold<S>(S initialValue, S combine(S previous, ServerSentEvent element)) → Future<S>
Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(ServerSentEvent element)) → Future<void>
Executes action on each element of this stream.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<ServerSentEvent>
Creates a wrapper Stream that intercepts some errors from this stream.
inherited
join([String separator = ""]) → Future<String>
Combines the string representation of elements into a single string.
inherited
lastWhere(bool test(ServerSentEvent element), {ServerSentEvent orElse()?}) → Future<ServerSentEvent>
Finds the last element in this stream matching test.
inherited
listen(void onData(ServerSentEvent event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<ServerSentEvent>
Adds a subscription to this stream.
inherited
map<S>(S convert(ServerSentEvent event)) → Stream<S>
Transforms each element of this stream into a new stream event.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pipe(StreamConsumer<ServerSentEvent> streamConsumer) → Future
Pipes the events of this stream into streamConsumer.
inherited
reduce(ServerSentEvent combine(ServerSentEvent previous, ServerSentEvent element)) → Future<ServerSentEvent>
Combines a sequence of values by repeatedly applying combine.
inherited
removeEventType(String event) → bool
Removes the given event type from the stream for listening.
singleWhere(bool test(ServerSentEvent element), {ServerSentEvent orElse()?}) → Future<ServerSentEvent>
Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<ServerSentEvent>
Skips the first count data events from this stream.
inherited
skipWhile(bool test(ServerSentEvent element)) → Stream<ServerSentEvent>
Skip data events from this stream while they are matched by test.
inherited
take(int count) → Stream<ServerSentEvent>
Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(ServerSentEvent element)) → Stream<ServerSentEvent>
Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<ServerSentEvent> sink)?}) → Stream<ServerSentEvent>
Creates a new stream with the same events as this stream.
inherited
toList() → Future<List<ServerSentEvent>>
Collects all elements of this stream in a List.
inherited
toSet() → Future<Set<ServerSentEvent>>
Collects the data of this stream in a Set.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamTransformer<ServerSentEvent, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
inherited
where(bool test(ServerSentEvent event)) → Stream<ServerSentEvent>
Creates a new stream from this stream that discards some elements.
inherited

Operators

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