view @ 406:30cf284e5680

Created wiki page through web user interface.
date Mon, 02 Dec 2013 01:58:57 +0000
line wrap: on
line source

#summary Subscribe to pubsub nodes using the HTML5 EventSource API
#labels Stage-Beta

= Introduction =

[ Server-Sent Events] is a simple HTTP/line-based protocol supported in HTML5, making it easy to receive a stream of "events" in realtime using the Javascript [ EventSource API].

EventSource is supported in [ most modern browsers], and for the remainder there are 'polyfill' compatibility layers such as [ EventSource.js] and [ jquery.eventsource].

= Details =

Subscribing to a node from Javascript is easy:

    var source = new EventSource('');
    source.onmessage = function (event) {
        console.log(; // Do whatever you want with the data here

== Cross-domain issues ==
The same cross-domain restrictions apply to EventSource that apply to BOSH, and support for CORS is not clearly standardized yet. You may want to proxy connections through your web server for this reason. See [ BOSH: Cross-domain issues] for more information.

= Configuration =
There is no special configuration for this module. Simply load it onto a pubsub component like so:

   Component "" "pubsub"
       modules_enabled = { "pubsub_eventsource" }

As it uses HTTP to serve the event streams, you can use Prosody's standard [ HTTP configuration options] to control how/where the streams are served.

*Note about URLs:* It is important to get the event streams from the correct hostname (that of the pubsub host). An example stream URL is ``. If you need to access the streams using another hostname (e.g. ``) you can use the `http_host` option under the Component, e.g. `http_host = ""`. For more information see the [ 'Virtual Hosts'] section of our HTTP documentation.

= Compatibility =
|| 0.9 || Works ||
|| 0.8 || Doesn't work ||
|| Trunk || Works ||