annotate mod_pubsub_eventsource.wiki @ 502:3c81d8a9f1e2

Documentation for the new mod_admin_message module.
author mikael.berthe@gmail.com
date Sun, 25 Jan 2015 19:07:33 +0000
parents 30cf284e5680
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
406
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
1 #summary Subscribe to pubsub nodes using the HTML5 EventSource API
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
2 #labels Stage-Beta
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
3
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
4 = Introduction =
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
5
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
6 [https://en.wikipedia.org/wiki/Server-sent_events 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 [https://developer.mozilla.org/en-US/docs/Web/API/EventSource EventSource API].
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
7
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
8 EventSource is supported in [http://caniuse.com/#feat=eventsource most modern browsers], and for the remainder there are 'polyfill' compatibility layers such as [https://github.com/remy/polyfills/blob/master/EventSource.js EventSource.js] and [https://github.com/rwldrn/jquery.eventsource jquery.eventsource].
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
9
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
10 = Details =
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
11
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
12 Subscribing to a node from Javascript is easy:
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
13
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
14 {{{
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
15 var source = new EventSource('http://pubsub.example.org:5280/eventsource/mynode');
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
16 source.onmessage = function (event) {
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
17 console.log(event.data); // Do whatever you want with the data here
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
18 };
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
19 }}}
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
20
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
21 == Cross-domain issues ==
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
22 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 [https://prosody.im/doc/setting_up_bosh#proxying_requests BOSH: Cross-domain issues] for more information.
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
23
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
24 = Configuration =
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
25 There is no special configuration for this module. Simply load it onto a pubsub component like so:
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
26
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
27 {{{
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
28 Component "pubsub.example.org" "pubsub"
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
29 modules_enabled = { "pubsub_eventsource" }
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
30 }}}
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
31
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
32 As it uses HTTP to serve the event streams, you can use Prosody's standard [https://prosody.im/doc/http HTTP configuration options] to control how/where the streams are served.
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
33
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
34 *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 `http://pubsub.example.org:5280/eventsource/mynode`. If you need to access the streams using another hostname (e.g. `example.org`) you can use the `http_host` option under the Component, e.g. `http_host = "example.org"`. For more information see the [https://prosody.im/doc/http#virtual_hosts 'Virtual Hosts'] section of our HTTP documentation.
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
35
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
36 = Compatibility =
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
37 || 0.9 || Works ||
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
38 || 0.8 || Doesn't work ||
30cf284e5680 Created wiki page through web user interface.
MWild1@gmail.com
parents:
diff changeset
39 || Trunk || Works ||