Support for asynchronous programming, with classes such as Future and Stream.

Understanding Futures and Streams is a prerequisite for writing just about any Dart program.

To use this library in your code:

import 'dart:async';

Future

A Future object represents a computation whose return value might not yet be available. The Future returns the value of the computation when it completes at some time in the future. Futures are often used for potentially lengthy computations such as I/O and interaction with users.

Many methods in the Dart libraries return Futures when performing tasks. For example, when binding an HttpServer to a host and port, the bind() method returns a Future.

 HttpServer.bind('127.0.0.1', 4444)
     .then((server) => print('${server.isBroadcast}'))
     .catchError(print);

Future.then registers a callback function that runs when the Future's operation, in this case the bind() method, completes successfully. The value returned by the operation is passed into the callback function. In this example, the bind() method returns the HttpServer object. The callback function prints one of its properties. Future.catchError registers a callback function that runs if an error occurs within the Future.

Stream

A Stream provides an asynchronous sequence of data. Examples of data sequences include individual events, like mouse clicks, or sequential chunks of larger data, like multiple byte lists with the contents of a file such as mouse clicks, and a stream of byte lists read from a file. The following example opens a file for reading. Stream.listen registers a callback function that runs each time more data is available.

Stream<List<int>> stream = new File('quotes.txt').openRead();
stream.transform(UTF8.decoder).listen(print);

The stream emits a sequence of a list of bytes. The program must interpret the bytes or handle the raw byte data. Here, the code uses a UTF8 decoder (provided in the dart:convert library) to convert the sequence of bytes into a sequence of Dart strings.

Another common use of streams is for user-generated events in a web app: The following code listens for mouse clicks on a button.

querySelector('#myButton').onClick.listen((_) => print('Click.'));

Other resources

Typedefs

ControllerCallback() → void

Type of a stream controller's onListen, onPause and onResume callbacks.

ControllerCancelCallback() → dynamic

Type of stream controller onCancel callbacks.

CreatePeriodicTimerHandler(Zone self, ZoneDelegate parent, Zone zone, Duration period, void f(Timer timer)) Timer

CreateTimerHandler(Zone self, ZoneDelegate parent, Zone zone, Duration duration, void f()) Timer

ErrorCallbackHandler(Zone self, ZoneDelegate parent, Zone zone, Object error, StackTrace stackTrace) AsyncError

ForkHandler(Zone self, ZoneDelegate parent, Zone zone, ZoneSpecification specification, Map zoneValues) Zone

HandleUncaughtErrorHandler(Zone self, ZoneDelegate parent, Zone zone, error, StackTrace stackTrace) → R

PrintHandler(Zone self, ZoneDelegate parent, Zone zone, String line) → void

RegisterBinaryCallbackHandler(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2)) ZoneBinaryCallback

RegisterCallbackHandler(Zone self, ZoneDelegate parent, Zone zone, R f()) ZoneCallback

RegisterUnaryCallbackHandler(Zone self, ZoneDelegate parent, Zone zone, R f(T arg)) ZoneUnaryCallback

RunBinaryHandler(Zone self, ZoneDelegate parent, Zone zone, R f(T1 arg1, T2 arg2), T1 arg1, T2 arg2) → R

RunHandler(Zone self, ZoneDelegate parent, Zone zone, R f()) → R

RunUnaryHandler(Zone self, ZoneDelegate parent, Zone zone, R f(T arg), T arg) → R

ScheduleMicrotaskHandler(Zone self, ZoneDelegate parent, Zone zone, void f()) → void

ZoneBinaryCallback(T1 arg1, T2 arg2) → R

ZoneCallback() → R

ZoneUnaryCallback(T arg) → R

Functions

runZoned(dynamic body(), {Map zoneValues, ZoneSpecification zoneSpecification, Function onError}) → dynamic

Runs body in its own zone.

scheduleMicrotask(void callback()) → void

Runs a function asynchronously.

Classes

Completer

A way to produce Future objects and to complete them later with a value or error.

DeferredLibrary

Indicates that loading of libraryName is deferred.

EventSink

An interface that abstracts creation or handling of Stream events.

Future

An object representing a delayed computation.

Stream

A source of asynchronous data events.

StreamConsumer

Abstract interface for a "sink" accepting multiple entire streams.

StreamController

A controller with the stream it controls.

StreamIterator

An Iterator like interface for the values of a Stream.

StreamSink

A object that accepts stream events both synchronously and asynchronously.

StreamSubscription

A subscription on events from a Stream.

StreamTransformer

The target of a Stream.transform call.

StreamView

Stream wrapper that only exposes the Stream interface.

SynchronousStreamController

A stream controller that delivers its events synchronously.

Timer

A count-down timer that can be configured to fire once or repeatedly.

Zone

A Zone represents the asynchronous version of a dynamic extent. Asynchronous callbacks are executed in the zone they have been queued in. For example, the callback of a future.then is executed in the same zone as the one where the then was invoked.

ZoneDelegate

This class wraps zones for delegation.

ZoneSpecification

This class provides the specification for a forked zone.

Exceptions / Errors

AsyncError

Pair of error and stack trace. Returned by Zone.errorCallback.

DeferredLoadException

Thrown when a deferred library fails to load.

TimeoutException

Thrown when a scheduled timeout happens while waiting for an async result.