Custom protocols

joris hermans edited this page May 8, 2015 · 4 revisions

Write your own custom protocol on top of Force.

First of all you need to define a package class. It represents your data package that represents the protocol that is been send through the wire of the websocket.

class PingPongPackage extends Package {

Then we need to define the protocol that has a generic type of the package class.

class PingPongProtocol extends Protocol<PingPongPackage> {
  ProtocolDispatch<PingPongPackage> dispatcher;
  bool shouldDispatch(data) {
      // Test what is typical for this protocol
      return data.contains("PING") || data.contains("PONG");
  PingPongPackage onConvert(data, {wsId: "-"}) {
    return new PingPongPackage.fromJson(JSON.decode(data), wsId: wsId);

In this class you have a method that looks at the data and returns a boolean when it is this protocol. Then you need a onConvert method so we can convert the Package from JSON to the Package data.

And last but not least you need to define your dispatcher logic to anticipate when you get a certain package.

class PingPongDispatcher extends ProtocolDispatch<PingPongPackage> {
  StreamController<String> _controller = new StreamController<String>();
  void dispatch(PingPongPackage ppp) {
    if (ppp.state == PingPongPackage.PING) {
      sendable.sendPackage(new PingPongPackage(PingPongPackage.PONG));
  Stream get state =>;

You need to override dispatch to handle the data package and anticipate on it. You have always access at the sendable object.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.