This MigratoryData client library is written in Dart. One important use of this library is that it allows you to use the Flutter framework for building realtime applications natively compiled for mobile (Android and iOS), web, and desktop from a single codebase.

Before reading this manual, it is recommended to read the Architecture guide.


The API exposed by MigratoryData client library for Dart is the same as the API exposed by the MigratoryData client libraries for all other supported programming languages such as JavaScript, Java, C++, C#, Python, PHP, Objective-C, etc. The API contains all the necessary operations for:

  • connecting to a cluster of one or more instances of MigratoryData Server version 6.x,
  • subscribing to one or more subjects,
  • getting real-time messages for the subscribed subjects, and
  • publishing real-time messages

Getting started

MigratoryData uses the standard pub tool for package management to make available MigratoryData client library for Dart.

To add the package to your Dart or Flutter application, add MigratoryData client library as a dependency in your pubspec.yaml as follows:

    migratorydata_client_dart_v6: ^1.0.6

Then, change to the directory of your application (the directory which contains pubspec.yaml) and run the following command:

$ dart pub get


Copy the code below to a file named client_dart_example.dart and run it using the following command:

$ dart client_dart_example.dart

Supposing the MigratoryData server version 6.x is installed locally on your machine, using the default configuration. This example client application connects to the MigratoryData server deployed locally at localhost:8800, subscribes to a subject /vehicles/1/speed, publishes to the MigratoryData server a message every 5 seconds (containing a random speed between 0 and 200) on the same subject, and receives from the MigratoryData server the published message in realtime.

You can also open in your web browser the welcome page of the MigratoryData server at http://localhost:8800 and use the demo web application you will find there to interact in realtime with this example client application written in Dart.

import 'dart:async';
import 'dart:convert';
import 'dart:typed_data';
import 'dart:math';

import 'package:migratorydata_client_dart_v6/client.dart';

void main() {
  var client = MigratoryDataClient();
  // client.setEncryption(true);

  Timer.periodic(Duration(seconds: 5), (Timer t) {

class ListenerImpl implements MigratoryDataListener {
  onMessage(MigratoryDataMessage message) {

  onStatus(String type, String info) {
    print("$type - $info");

Additional information

For more information please refer to MigratoryData Documentation.