Skip to content

Home

Jump to bottom
nmaster edited this page Jun 21, 2011 · 4 revisions

Welcome to the WXG (WebSocket-XMPP-Gateway) wiki!

WXG (pronounce as "Wixig") is a Java-implementation of a gateway enabling communication with native XMPP [1] servers over the WebSocket protocol [2] and API [3], as specified in [4].

Until now, one of the common techniques in using XMPP in JS-powered Web applications was to make use of BOSH [5] and XMPP over BOSH [6]. However, with the advent of the WebSocket protocol [2] and API [3] already widely available in modern Web browsers, the unstable and slow BOSH technique can and should be replaced. Currently, most XMPP servers are not equipped with connectors for receiving and delivering stanzas over the WebSocket protocol as specified in [4].

The following scheme shows the basic functionality of WXG:

Client <----> ws(xmpp) <----> WXG <----> xmpp <----> XMPP Server

As such, WXG realizes two basic use cases:

  1. When a client sends an XMPP stanza encapsulated in a WebSocket message, WXG "unpacks" the stanza and forwards it to the XMPP server natively.

  2. When an XMPP server directs a stanza to one of its clients, WXG receives the native stanza, wraps it into a WebSocket message and forwards it to the client.

Please check the Getting Started page to receive instructions on how to build, configure, and run WXG.

##References

  1. P. Saint-Andre. Extensible Messaging and Presence Protocol (XMPP): Core. RFC3920. Oct 2004. http://www.ietf.org/rfc/rfc3920.txt
  2. I. Fette. The WebSocket protocol. HyBi Working Group Internet Draft. Jun 2011. http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-09
  3. I. Hickson. The WebSocket API. W3C Editor's draft. Jun 2011. http://dev.w3.org/html5/websockets/
  4. J. Moffit, E. Cestari. An XMPP Sub-protocol for WebSocket. HyBi Working Group Internet Draft. Dec 2010. http://tools.ietf.org/html/draft-moffitt-xmpp-over-websocket-00
  5. I. Paterson, D. Smith, P. Saint-Andre, J. Moffitt. XEP-0124: Bidirectional-streams Over Synchronous HTTP (BOSH). XSF Draft Standard. Jul 2010. http://xmpp.org/extensions/xep-0124.html
  6. I. Paterson, P. Saint-Andre. XEP-0206: XMPP Over BOSH. XSF Draft Standard. Jul 2010. http://xmpp.org/extensions/xep-0206.html
Clone this wiki locally