Today, I had a brief chat with Kris about a potential AeroGear Notifier Client API...

The basic idea is to wrap messaging APIs (e.g. Stomp.js, Vertx's eventbus or Socket.io/Engine.io) behind a common client 'interface'.

Basically the AeroGear-Notifier should be able to connect to a messaging system in order to subscribe to a channel to reveice messages from that channel. The AG-Notifier is also able to publish messages to ANY channel. Of course,unsubscribe and disconnect are required too...

Sure... the above is not (YET) really a SPEC, but it's start.... the JS API of the AG-Notifier (DRAFT 0.0.1) could looks like this:

/**
 * Connects to a given URL. The callback is invoked after a connection has been established. In case of an error, an Error
 * object will be passed to the callback
 */
AeroGear.Notifier.connect(String url, function callback);

/**
 * Tears down the connection. The callback is invoked after a connection has been closed. In case of an error, an
 * Error object will be passed to the callback
 */
AeroGear.Notifier.disconnect(function callback);

/**
 * Subscribes to a channel. The callback function is invoked for every message, received on the given channel.
 */
AeroGear.Notifier.subscribe(String channel, function callback);

/**
 * Removes the subscription of the given channel.
 */
AeroGear.Notifier.unsubscribe(String channel);

/**
 * Publishes a message to a given channel
 */
AeroGear.Notifier.publish(String channel, Object message);

AeroGear.Notifier.CONNECTING = 0;
AeroGear.Notifier.OPEN = 1;
AeroGear.Notifier.CLOSING = 2;
AeroGear.Notifier.CLOSED = 3;

Implementation of the Adapters

The different adapter implementations will be done separately: ag-notifier-vertx.js...