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.

factory
ReceivePort.fromRawReceivePort(RawReceivePort rawPort)

Creates a ReceivePort from a RawReceivePort.

factory

Properties

first → Future

Returns the first element of the stream.

read-only, inherited
hashCode → int

Get a hash code for this object.

read-only, inherited
isBroadcast → bool

Reports whether this stream is a broadcast stream.

read-only, inherited
isEmpty → Future<bool>

Reports whether this stream contains any elements.

read-only, inherited
last → Future

Returns the last element of the stream.

read-only, inherited
length → Future<int>

Counts the elements in the stream.

read-only, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited
sendPort → SendPort

Returns a SendPort that sends to this receive port.

read-only
single → Future

Returns the single element.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

any(bool test(T element)) → Future<bool>

Checks whether test accepts any element provided by this stream.

inherited
asBroadcastStream({void onListen(StreamSubscription<T> subscription), void onCancel(StreamSubscription<T> subscription) }) → Stream

Returns a multi-subscription stream that produces the same events as this.

inherited
asyncExpand<E>(Stream<E> convert(T event)) → Stream<E>

Creates a new stream with the events of a stream per original event.

inherited
asyncMap<E>(dynamic convert(T event)) → Stream<E>

Creates a new stream with each data event of this stream asynchronously mapped to a new event.

inherited
close() → void

Closes this.

contains(Object needle) → Future<bool>

Checks whether needle occurs in the elements provided by this stream.

inherited
distinct([bool equals(T previous, T next) ]) → Stream

Skips data events if they are equal to the previous data event.

inherited
drain<E>([E futureValue ]) → Future<E>

Discards all data on the stream, but signals when it's done or an error occurred.

inherited
elementAt(int index) → Future

Returns the value of the indexth data event of this stream.

inherited
every(bool test(T element)) → Future<bool>

Checks whether test accepts all elements provided by this stream.

inherited
expand<S>(Iterable<S> convert(T value)) → Stream<S>

Creates a new stream from this stream that converts each element into zero or more events.

inherited
firstWhere(bool test(T element), { Object defaultValue() }) → Future

Finds the first element of this stream matching test.

inherited
fold<S>(S initialValue, S combine(S previous, T element)) → Future<S>

Reduces a sequence of values by repeatedly applying combine.

inherited
forEach(void action(T element)) → Future

Executes action on each data event of the stream.

inherited
handleError(Function onError, { bool test(error) }) → Stream

Creates a wrapper Stream that intercepts some errors from this stream.

inherited
join([String separator = "" ]) → Future<String>

Collects string of data events' string representations.

inherited
lastWhere(bool test(T element), { Object defaultValue() }) → Future

Finds the last element in this stream matching test.

inherited
listen(void onData(message), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription

Inherited from Stream.

map<S>(S convert(T event)) → Stream<S>

Creates a new stream that converts each element of this stream to a new value using the convert function.

inherited
noSuchMethod(Invocation invocation) → dynamic

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

inherited
pipe(StreamConsumer streamConsumer) → Future

Pipe the events of this stream into streamConsumer.

inherited
reduce(dynamic combine(T previous, T element)) → Future

Reduces a sequence of values by repeatedly applying combine.

inherited
singleWhere(bool test(T element)) → Future

Finds the single element in this stream matching test.

inherited
skip(int count) → Stream

Skips the first count data events from this stream.

inherited
skipWhile(bool test(T element)) → Stream

Skip data events from this stream while they are matched by test.

inherited
take(int count) → Stream

Provides at most the first count data events of this stream.

inherited
takeWhile(bool test(T element)) → Stream

Forwards data events while test is successful.

inherited
timeout(Duration timeLimit, { void onTimeout(EventSink<T> sink) }) → Stream

Creates a new stream with the same events as this stream.

inherited
toList() → Future<List>

Collects the data of this stream in a List.

inherited
toSet() → Future<Set>

Collects the data of this stream in a Set.

inherited
toString() → String

Returns a string representation of this object.

inherited
transform<S>(StreamTransformer<dynamic, S> streamTransformer) → Stream<S>

Chains this stream as the input of the provided StreamTransformer.

inherited
where(bool test(T event)) → Stream

Creates a new stream from this stream that discards some data events.

inherited