AutobahnJS

AutobahnJS is a JavaScript client library that implements The WebSocket Application Messaging Protocol (WAMP):

• implements WAMP v1, works with any WAMP server
• provides asynchronous RPC and PubSub messaging patterns
• easy to use Promise-based API
• pluggable promises/deferreds: use when.js (built-in), jQuery, Dojo or others
• flexible, automatic reconnect
• session authentication (WAMP-CRA)
• no dependencies
• tiny size (65kB source, 24kB minified, 7kB compressed)
• Open-Source (MIT License)

Get it

You can link to the latest prebuilt release hosted on Amazon S3 here

1. http://autobahn.s3.amazonaws.com/js/autobahn.min.js
2. http://autobahn.s3.amazonaws.com/js/autobahn.js

What is that?

WebSocket is already built into modern browsers and provides bidirectional low-latency messaging.

However, as such, it is quite low-level. Web apps often have a need for higher level messaging patterns:

• Publish & Subscribe
• Remote Procedure Calls

This is where WAMP enters. WAMP runs on top of raw WebSocket and provides asynchronous RPC and PubSub.

Technically, WAMP is a proper WebSocket subprotocol that uses JSON as message serialization format. WAMP was designed to be easy to use and simple to implement.

AutobahnJS implements WAMP in JavaScript to be used in browser based applications.

Where to go

For more information, including getting started, tutorials and reference documentation, please visit the project's homepage.

Get in touch

Get in touch on IRC #autobahn on chat.freenode.net or join the mailing list.

Acknowledgements

AutobahnJS includes code from the following open-source projects

• when.js
• CryptoJS

Special thanks to the Coders with an Unhealthy Javascript Obsession for creating when.js - A lightweight Promise and when() implementation, plus other async goodies.

Building

Building AutobahnJS will create a single file, minimized version of the library.

To build, you will need

• Google Closure Compiler
• SCons

SCons is a Python based build tool, so you will need Python as well.

Set environment variables:

1. JAVA_HOME pointing to your Java run-time
2. JS_COMPILER pointing to the Google Closure compiler.jar

Now clone the repo, set the appropriate AutobahnJS version and build:

git clone git://github.com/tavendo/AutobahnJS.git
cd AutobahnJS
vi version.txt
scons

This will produce 2 files

build/autobahn.js
build/autobahn.min.js

To clean up your build

scons -uc

To update the submodules:

cd when
git pull
git checkout 1.8.1
cd ..
git add when

To update CryptoJS: needs to be done manually, since they are not on Git.

ExtJS Extension

AutobahnExtJS provides and Autobahn/WAMP proxy and support code for ExtJS. Please see the autobahnextjs folder for code and more information.