How to timeout a future computation after a timeLimit?

Question

When defining a Future as follows:

Future<HttpRequest> httpRequest =  HttpRequest.request(url,
      method: method, requestHeaders: requestHeaders);

I want to handle a timeout after 5 secondes. I'm writing my code like this :

httpRequest.timeout(const Duration (seconds:5),onTimeout : _onTimeout());

Where my timeout function is :

_onTimeout() => print("Time Out occurs");

According to the Future timeout() method documentation , If onTimeout is omitted, a timeout will cause the returned future to complete with a TimeoutException. But With my code , my method _onTimeout() is properly called (but immediately, not after 5 seconds) and I always get a

TimeException after 5 seconds... (TimeoutException after 0:00:05.000000: Future not completed )

Am I missing something ?

Günter Zöchbauer · Accepted Answer · 2015-11-24T16:58:43.763

21

Change this line

httpRequest.timeout(const Duration (seconds:5),onTimeout : _onTimeout());

to

httpRequest.timeout(const Duration (seconds:5),onTimeout : () => _onTimeout());

or just pass a reference to the function (without the ())

httpRequest.timeout(const Duration (seconds:5),onTimeout : _onTimeout);

This way the closure that calls _onTimeout() will be passed to timeout(). In the former code the result of the _onTimeout() call will be passed to timeout()

edited Nov 24 '15 at 16:58

answered Nov 24 '15 at 15:17

Günter Zöchbauer

623,577
216
2,003
1,567

3

Or it can simply be `onTimeout : _onTimeout` (without parenthesis). – Maciej Sz Nov 24 '15 at 15:36

score 12 · Answer 2 · answered Dec 04 '20 at 06:25

12

Future.await[_doSome].then((data){
    print(data);
    }).timeout(Duration(seconds: 10));

answered Dec 04 '20 at 06:25

Nhật Trần

2,522
1
20
20

Brilliant. I didnt know that timeouts was built into Future's. Thx! – bobmoff May 05 '21 at 08:53

score 3 · Answer 3 · answered Dec 20 '21 at 05:43

Using async/await style. You can add .timeout to any Future you are awaiting.

final result = await InternetAddress
   .lookup('example.com')
   .timeout(
      Duration(seconds: 10),
      onTimeout: () => throw TimeoutException('Can\'t connect in 10 seconds.'),
    );

score 0 · Answer 4 · answered May 09 '22 at 15:51

In order to stop any Future by timeout one can use timeout(). There are two examples:

Throw exception after timeout

  final someHardTaskFuture = Future.delayed(const Duration(hours: 1), () => 42);
  final newFutureWithTimeoutAndException = someHardTaskFuture.timeout(const Duration(seconds: 3));

Returns default value (11) on timeout

  final someHardTaskFuture = Future.delayed(const Duration(hours: 1), () => 42);
  final newFutureWithTimeoutAndDefaultValue = someHardTaskFuture
      .timeout(const Duration(seconds: 3), onTimeout: () => 11);
  print(await newFutureWithTimeoutAndDefaultValue);

How to timeout a future computation after a timeLimit?

4 Answers4

Linked