ReceivePort class

Together with SendPort, the only means of communication between isolates.

Together with SendPort, the only means of communication between isolates.

ReceivePorts have a sendPort getter which returns a SendPort. Any message that is sent through this SendPort is delivered to the ReceivePort it has been created from. There, the message is dispatched to the ReceivePort's listener.

A ReceivePort is a non-broadcast stream. This means that it buffers incoming messages until a listener is registered. Only one listener can receive messages. See Stream.asBroadcastStream for transforming the port to a broadcast stream.

A ReceivePort may have many SendPorts.

Implements

Constructors

ReceivePort()
Opens a long-lived port for receiving messages.
ReceivePort.fromRawReceivePort(RawReceivePort rawPort)
Creates a ReceivePort from a RawReceivePort.

Instance Properties

sendPort SendPort
read-only
isEmpty Future<bool> Inherited
read-only
isBroadcast bool Inherited
read-only
first Future Inherited
read-only
last Future Inherited
read-only
single Future Inherited
read-only
length Future<int> Inherited
read-only

Instance Methods

listen(void onData(message), {Function onError, void onDone(), bool cancelOnError}) → StreamSubscription
Inherited from Stream.
close() → void
Closes this.
pipe(StreamConsumer streamConsumer) → Future Inherited
Pipe the events of this stream into streamConsumer.
take(int count) → Stream Inherited
Provides at most the first n values of this stream.
map(dynamic convert(T event)) → Stream Inherited
Creates a new stream that converts each element of this stream to a new value using the convert function.
timeout(Duration timeLimit, {void onTimeout(EventSink sink)}) → Stream Inherited
Creates a new stream with the same events as this stream.
distinct([bool equals(T previous, T next)]) → Stream Inherited
Skips data events if they are equal to the previous data event.
takeWhile(bool test(T element)) → Stream Inherited
Forwards data events while test is successful.
fold(initialValue, dynamic combine(previous, T element)) → Future Inherited
Reduces a sequence of values by repeatedly applying combine.
toSet() → Future<Set> Inherited
Collects the data of this stream in a Set.
firstWhere(bool test(T element), {Object defaultValue()}) → Future Inherited
Finds the first element of this stream matching test.
forEach(void action(T element)) → Future Inherited
Executes action on each data event of the stream.
skipWhile(bool test(T element)) → Stream Inherited
Skip data events from this stream while they are matched by test.
join([String separator = ""]) → Future<String> Inherited
Collects string of data events' string representations.
contains(Object needle) → Future<bool> Inherited
Checks whether needle occurs in the elements provided by this stream.
asyncExpand(Stream convert(T event)) → Stream Inherited
Creates a new stream with the events of a stream per original event.
lastWhere(bool test(T element), {Object defaultValue()}) → Future Inherited
Finds the last element in this stream matching test.
singleWhere(bool test(T element)) → Future Inherited
Finds the single element in this stream matching test.
drain([futureValue]) → Future Inherited
Discards all data on the stream, but signals when it's done or an error occured.
asyncMap(dynamic convert(T event)) → Stream Inherited
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
handleError(Function onError, {bool test(error)}) → Stream Inherited
Creates a wrapper Stream that intercepts some errors from this stream.
reduce(T combine(T previous, T element)) → Future Inherited
Reduces a sequence of values by repeatedly applying combine.
transform(StreamTransformer streamTransformer) → Stream Inherited
Chains this stream as the input of the provided StreamTransformer.
every(bool test(T element)) → Future<bool> Inherited
Checks whether test accepts all elements provided by this stream.
any(bool test(T element)) → Future<bool> Inherited
Checks whether test accepts any element provided by this stream.
toList() → Future<List> Inherited
Collects the data of this stream in a List.
where(bool test(T event)) → Stream Inherited
Creates a new stream from this stream that discards some data events.
asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription)}) → Stream Inherited
Returns a multi-subscription stream that produces the same events as this.
skip(int count) → Stream Inherited
Skips the first count data events from this stream.
expand(Iterable convert(T value)) → Stream Inherited
Creates a new stream from this stream that converts each element into zero or more events.
elementAt(int index) → Future Inherited
Returns the value of the indexth data event of this stream.