ReceivePort abstract class
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()
factory
-
Opens a long-lived port for receiving messages.
-
ReceivePort.fromRawReceivePort(
RawReceivePort rawPort)
factory
-
Creates a ReceivePort from a RawReceivePort.
Properties
-
sendPort →
SendPort
read-only
-
Returns a
SendPort
that sends to this receive port. -
first →
Future
read-only, inherited
-
Returns the first element of the stream.
-
hashCode →
int
read-only, inherited
-
The hash code for this object.
-
isBroadcast →
bool
read-only, inherited
-
Whether this stream is a broadcast stream.
-
isEmpty →
Future<
bool>
read-only, inherited
-
Reports whether this stream contains any elements.
-
last →
Future
read-only, inherited
-
Returns the last element of the stream.
-
length →
Future<
int>
read-only, inherited
-
Counts the elements in the stream.
-
runtimeType →
Type
read-only, inherited
-
A representation of the runtime type of the object.
-
single →
Future
read-only, inherited
-
Returns the single element.
Operators
-
operator ==(
other) → bool inherited -
The equality operator.
Methods
-
close(
) → void -
Closes
this
. -
listen(
void onData(message), { Function onError, void onDone(), bool cancelOnError }) → StreamSubscription -
Inherited from Stream.
-
any(
bool test(T element)) → Future< bool> inherited -
Checks whether
test
accepts any element provided by this stream. -
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.
-
asyncExpand<E>(
Stream<E> convert(T event)) → Stream<E> inherited -
Creates a new stream with the events of a stream per original event.
-
asyncMap<E>(
dynamic convert(T event)) → Stream<E> inherited -
Creates a new stream with each data event of this stream asynchronously mapped to a new event.
-
contains(
Object needle) → Future< bool> inherited -
Checks whether
needle
occurs in the elements provided by this stream. -
distinct(
[ bool equals(T previous, T next) ]) → Stream inherited -
Skips data events if they are equal to the previous data event.
-
drain<E>(
[E futureValue ]) → Future<E> inherited -
Discards all data on the stream, but signals when it's done or an error occurred.
-
elementAt(
int index) → Future inherited -
Returns the value of the
index
th data event of this stream. -
every(
bool test(T element)) → Future< bool> inherited -
Checks whether
test
accepts all elements provided by this stream. -
expand<S>(
Iterable<S> convert(T value)) → Stream<S> inherited -
Creates a new stream from this stream that converts each element into zero or more events.
-
firstWhere(
bool test(T element), { Object defaultValue() }) → Future inherited -
Finds the first element of this stream matching
test
. -
fold<S>(
S initialValue, S combine(S previous, T element)) → Future<S> inherited -
Reduces a sequence of values by repeatedly applying
combine
. -
forEach(
void action(T element)) → Future inherited -
Executes
action
on each data event of the stream. -
handleError(
Function onError, { bool test(error) }) → Stream inherited -
Creates a wrapper Stream that intercepts some errors from this stream.
-
join(
[ String separator = "" ]) → Future< String> inherited -
Collects string of data events' string representations.
-
lastWhere(
bool test(T element), { Object defaultValue() }) → Future inherited -
Finds the last element in this stream matching
test
. -
map<S>(
S convert(T event)) → Stream<S> inherited -
Creates a new stream that converts each element of this stream to a new value using the
convert
function. -
noSuchMethod(
Invocation invocation) → dynamic inherited -
Invoked when a non-existent method or property is accessed.
-
pipe(
StreamConsumer streamConsumer) → Future inherited -
Pipe the events of this stream into
streamConsumer
. -
reduce(
dynamic combine(T previous, T element)) → Future inherited -
Reduces a sequence of values by repeatedly applying
combine
. -
singleWhere(
bool test(T element)) → Future inherited -
Finds the single element in this stream matching
test
. -
skip(
int count) → Stream inherited -
Skips the first
count
data events from this stream. -
skipWhile(
bool test(T element)) → Stream inherited -
Skip data events from this stream while they are matched by
test
. -
take(
int count) → Stream inherited -
Provides at most the first
count
data events of this stream. -
takeWhile(
bool test(T element)) → Stream inherited -
Forwards data events while
test
is successful. -
timeout(
Duration timeLimit, { void onTimeout( EventSink<T> sink) }) → Stream inherited -
Creates a new stream with the same events as this stream.
-
toList(
) → Future< List> inherited -
Collects the data of this stream in a List.
-
toSet(
) → Future< Set> inherited -
Collects the data of this stream in a Set.
-
toString(
) → String inherited -
Returns a string representation of this object.
-
transform<S>(
StreamTransformer<dynamic, S> streamTransformer) → Stream<S> inherited -
Chains this stream as the input of the provided StreamTransformer.
-
where(
bool test(T event)) → Stream inherited -
Creates a new stream from this stream that discards some data events.
© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dartlang.org/stable/1.24.3/dart-isolate/ReceivePort-class.html