Dart Force Framework

A realtime web framework for dart.

With this framework communication between client and server becomes easy, without any boilerplate code.

Walkthrough

Client side

Import the client side library for dart force.

import 'package:force/force_browser.dart';

First create a client.

 ForceClient forceClient = new ForceClient();
 forceClient.connect();
 

Listen on the connection, when it is established and when is been broken.

 forceClient.onConnecting.listen((e) {
      if (e.type=="connected") {
        ...
      } else if (e.type=="disconnected") {
        ...
      }
 });
 

Listen on messages with the request of text.

 forceClient.on("text", (e, sender) {
      ...
 });

You can also send messages to the server.

forceClient.send('text', request);
Server Side

Import Serverside code for dart force.

import 'package:force/force_serverside.dart';

Instantiate a forceserver.

ForceServer fs = new ForceServer( port: 9223, startPage: 'start.html' );

Listen on messages of type text and react upon that.

fs.on('text', (e, sendable) { 
    var json = e.json;
    var line = json['line'];
    sendable.send('text', { 'line': line });
});

You can also serve files from the server part.

fs.start().then((_) {
    fs.serve("/client.dart").listen((request) { 
      fs.serveFile("../web/client.dart", request);
    });
});

Other features

Profile info

Adding profile data on a connection, this will make it easy to send a message to a certain profile group or sending messages to an individual, without knowing his websocket id.

On the client you can set Profile data.

 var profileInfo = { 'name' : chatName};
 forceClient.initProfileInfo(profileInfo);

On the server you can send something to a profile or a profile group by the following method in sendable.

sendable.sendWithProfile('name', name, 'private', message);

TODO

  • fallback support for legacy browser with no capability of websockets
  • adding authentication support and security support
  • writing tests

Libraries

dart_force_client_lib
dart_force_common_lib
dart_force_server_lib