annotate mod_websocket.wiki @ 204:b3095d15dd90

mod_register_url: A little cleanup for the docs.
author waqas20
date Fri, 02 Sep 2011 08:11:29 +0000
parents a61452a7f698
children e6cc6bf08560
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
118
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
1 #summary Simple XMPP-over-websocket support
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
2 #labels Stage-Alpha
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
3
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
4 = Introduction =
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
5
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
6 [http://en.wikipedia.org/wiki/Web_Sockets Web Sockets] is a new protocol for providing web pages with simple two-way communication with a web server.
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
7
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
8 In our case it is interesting to tunnel XMPP over web sockets, as an alternative to e.g. BOSH, web sockets having less overhead.
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
9
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
10 Note that the Web Socket specification has not been finalized, and is still evolving. There are currently no XMPP libraries capable of Web Sockets, but a good candidate for initial support is [http://code.stanziq.com/strophe/ Strophe.js].
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
11
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
12 = Usage =
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
13
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
14 Simply add mod_websocket to your modules_enabled list, as you would any other module. The repository includes a demo websocket.html file to show connecting to the socket. It doesn't yet perform any XMPP (see above comment about Strophe).
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
15
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
16 = Compatibility =
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
17 ||0.7||Works||
a61452a7f698 Created wiki page through web user interface.
MWild1
parents:
diff changeset
18 ||0.6||Not supported||