EventSource class

An EventSource client that exposes a Stream of Events.

Inheritance

Properties

client ↔ Client
getter/setter pair
first → Future<Event>
The first element of this stream.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
headers → Map?
final
isBroadcast → bool
Whether this stream is a broadcast stream.
no setterinherited
isEmpty → Future<bool>
Whether this stream contains any elements.
no setterinherited
last → Future<Event>
The last element of this stream.
no setterinherited
length → Future<int>
The number of elements in this stream.
no setterinherited
onError → Stream<Event>
no setter
onMessage → Stream<Event>
no setter
onOpen → Stream<Event>
no setter
readyState → EventSourceReadyState
no setter
readyStateController ↔ StreamController<EventSourceReadyState>
getter/setter pair
responseStream ↔ ByteStream?
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Future<Event>
The single element of this stream.
no setterinherited
url → Uri
final

Methods

any(bool test(Event element)) → Future<bool>
Checks whether test accepts any element provided by this stream.
inherited
asBroadcastStream({void onListen(StreamSubscription<Event> subscription)?, void onCancel(StreamSubscription<Event> subscription)?}) → Stream<Event>
Returns a multi-subscription stream that produces the same events as this.
inherited
asyncExpand<E>(Stream<E>? convert(Event event)) → Stream<E>
Transforms each element into a sequence of asynchronous events.
inherited
asyncMap<E>(FutureOr<E> convert(Event 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(Event previous, Event next)?]) → Stream<Event>
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<Event>
Returns the value of the indexth data event of this stream.
inherited
every(bool test(Event element)) → Future<bool>
Checks whether test accepts all elements provided by this stream.
inherited
expand<S>(Iterable<S> convert(Event element)) → Stream<S>
Transforms each element of this stream into a sequence of elements.
inherited
firstWhere(bool test(Event element), {Event orElse()?}) → Future<Event>
Finds the first element of this stream matching test.
inherited
fold<S>(S initialValue, S combine(S previous, Event element)) → Future<S>
Combines a sequence of values by repeatedly applying combine.
inherited
forEach(void action(Event element)) → Future<void>
Executes action on each element of this stream.
inherited
handleError(Function onError, {bool test(dynamic error)?}) → Stream<Event>
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(Event element), {Event orElse()?}) → Future<Event>
Finds the last element in this stream matching test.
inherited
listen(void onData(Event event)?, {Function? onError, void onDone()?, bool? cancelOnError}) → StreamSubscription<Event>
Adds a subscription to this stream.
override
map<S>(S convert(Event 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<Event> streamConsumer) → Future
Pipes the events of this stream into streamConsumer.
inherited
reduce(Event combine(Event previous, Event element)) → Future<Event>
Combines a sequence of values by repeatedly applying combine.
inherited
reopen() → Future<void>
singleWhere(bool test(Event element), {Event orElse()?}) → Future<Event>
Finds the single element in this stream matching test.
inherited
skip(int count) → Stream<Event>
Skips the first count data events from this stream.
inherited
skipWhile(bool test(Event element)) → Stream<Event>
Skip data events from this stream while they are matched by test.
inherited
take(int count) → Stream<Event>
Provides at most the first count data events of this stream.
inherited
takeWhile(bool test(Event element)) → Stream<Event>
Forwards data events while test is successful.
inherited
timeout(Duration timeLimit, {void onTimeout(EventSink<Event> sink)?}) → Stream<Event>
Creates a new stream with the same events as this stream.
inherited
toList() → Future<List<Event>>
Collects all elements of this stream in a List.
inherited
toSet() → Future<Set<Event>>
Collects the data of this stream in a Set.
inherited
toString() → String
A string representation of this object.
inherited
transform<S>(StreamTransformer<Event, S> streamTransformer) → Stream<S>
Applies streamTransformer to this stream.
inherited
where(bool test(Event event)) → Stream<Event>
Creates a new stream from this stream that discards some elements.
inherited

Operators

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

Static Methods

connect(dynamic url, {Client? client, String? lastEventId, Map? headers, String? body, String? method, bool? openOnlyOnFirstListener, StreamController<EventSourceReadyState>? readyStateController, bool? closeOnLastListener}) → Future<EventSource>
Create a new EventSource by connecting to the specified url. If you want to be able to listen to the state changes you need to provide your own readyStateController as broadcast controllers do not store state.