Difference between await for and listen in Dart

Question

I am trying to create a web server stream. Here is the code:

import 'dart:io';

main() async {
  HttpServer requestServer = await HttpServer.bind(InternetAddress.LOOPBACK_IP_V4, 8000);

requestServer.listen((request) {   //comment out this or the await for to work
  request.response
    ..write("This is a listen stream")
    ..close();
});

  await for (HttpRequest request in requestServer) {
  request.response
    ..write("This is an await for stream")
    ..close();
  }
}

What is the difference between listen and await for? They both do not work at the same time. You need to comment out one or the other to work, but there doesn't seem to be a difference in function here. Are there circumstances where there is a difference, and when should you use one over the other?

Argenti Apparatus · Accepted Answer · 2017-03-05T21:13:27.923

43

Given:

Stream<String> stream = new Stream<String>.fromIterable(['mene', 'mene', 'tekel', 'parsin']);

then:

print('BEFORE');
stream.listen((s) { print(s); });
print('AFTER');

yields:

BEFORE
AFTER
mene
mene
tekel
parsin

whereas:

print('BEFORE');
await for(String s in stream) { print(s); }
print('AFTER');

yields:

BEFORE
mene
mene
tekel
parsin
AFTER

stream.listen() sets up code that will be put on the event queue when an event arrives, then following code is executed.

await for suspends between events and keeps doing so until the stream is done, so code following it will not be executed until that happens.

I use `await for when I have a stream that I know will have finite events, and I need to process them before doing anything else (essentially as if I'm dealing with a list of futures).

Check https://www.dartlang.org/articles/language/beyond-async for a description of await for.

edited Mar 05 '17 at 21:13

answered Mar 05 '17 at 20:38

Argenti Apparatus

2,979
1
21
33

1

The `await for(var x in stream) ... ` syntax is a closer equivalent to `await stream.forEach((x) { ... })` than to `listen`, just like `for (var x in iterable) ...` is similar to `iterable.forEach((x) { ... })`. The differences come from the `for` loops allowing control flow that `forEach` doesn't. – lrn Mar 07 '17 at 10:01
the link is broken – Suragch Feb 03 '20 at 08:18
Great explanation! – benChung Jun 26 '20 at 02:06
Helped me a lot, thanks! – Leandro Gamarra Apr 29 '21 at 15:32

score 7 · Answer 2 · answered Mar 05 '17 at 20:40

The main difference is when there's code afterwards. listen only register the handler and the execution continue. await for will retain execution until the stream is closed.

Thus if you add a print('hello'); at the end of your main you shouldn't see hello in the output with await for (because the request stream is never closed). Try the following code on dartpad to see the differences :

import 'dart:async';
main() async {
  tenInts.listen((i) => print('int $i'));
  //await for (final i in tenInts) {
  //  print('int $i');
  //}
  print('hello');
}
Stream<int> get tenInts async* {
  for (int i = 1; i <= 10; i++) yield i;
}

score 2 · Answer 3 · answered Jan 15 '20 at 03:16

A more imporant difference is that await for serializes the consumption of the stream items while listen will process them concurrently.

For example the code below:

import 'dart:async';

Future<void> process(int i) async {
  print("start $i");
  await new Future.delayed(const Duration(seconds: 1));
  print("end $i");
}

main() async {
  await for (final i in tenInts) {
    await process(i);
  }
  tenInts.listen((i) async => await process(i));
  print('hello');
}
Stream<int> get tenInts async* {
  for (int i = 1; i <= 10; i++) yield i;
}

yields

start 1
end 1
start 2
end 2
start 3
end 3
start 4
end 4
start 5
end 5
start 6
end 6
start 7
end 7
start 8
end 8
start 9
end 9
start 10
end 10
hello
start 1
start 2
start 3
start 4
start 5
start 6
start 7
start 8
start 9
start 10
end 1
end 2
end 3
end 4
end 5
end 6
end 7
end 8
end 9
end 10

score 0 · Answer 4 · answered Jan 24 '21 at 03:10

Another difference can be the listen() returns you a StreamSubscription object, which can be used to cancel/pause the subscription at any later point of time. You can set callbacks to be called for each data event or error event, and when the stream is closed.

The below demonstrates that after listening to stream for 5 seconds, we will cancel it.

Stream<int> gen() async* {
  for (int i = 1; i <= 10; i++) {
    await Future.delayed(Duration(seconds: 1));
    yield i;
  }
  print("done");
}

main() async {
  Stream<int> stream = gen();
  var subscription = stream.listen((item){
    print(item);
  });
  
  await Future.delayed(Duration(seconds: 5));
  subscription.cancel();
  
  print("Exit");
}

Output:
1
2
3
4
Exit

Difference between await for and listen in Dart

4 Answers4

Linked