7.9 KiB
Open-source real-time framework for Web, Mobile & Internet of Things.
Latest release: v (Changelog)
is a subproject of the Autobahn project and provides open-source implementations of
in Python 2 and 3, running on Twisted and asyncio.
WebSocket allows bidirectional real-time messaging on the Web while WAMP provides applications with high-level communication abstractions in an open standard WebSocket based protocol.
features
- framework for WebSocket / WAMP clients and servers
- compatible with Python 2.6, 2.7, 3.3 and 3.4
- runs on CPython, PyPy and Jython
- runs under Twisted and asyncio
- implements WebSocket RFC6455 (and older versions like Hybi-10+ and Hixie-76)
- implements WebSocket compression
- implements WAMPv2 (and WAMPv1)
- supports TLS (secure WebSocket) and proxies
- Open-source (Apache 2 license)
and much more.
Further, is written with these goals
- high-performance, fully asynchronous and scalable code
- best-in-class standards conformance and security
We do take those design and implementation goals quite serious. For example, has 100% strict passes with AutobahnTestsuite, the quasi industry standard of WebSocket protocol test suites we originally created only to test ;)
What can I do with this stuff?
WebSocket is great for apps like chat, trading, multi-player games or real-time charts. It allows you to actively push information to clients as it happens.
Further, WebSocket allows you to real-time enable your Web user interfaces: always current information without reloads or polling. UIs no longer need to be a boring, static thing. Looking for the right communication technology for your next-generation Web apps? Enter WebSocket.
And WebSocket works great not only on the Web, but also as a protocol for wiring up the Internet-of-Things (IoT). Connecting a sensor or actor to other application components in real-time over an efficient protocol. Plus: you are using the same protocol to connect frontends like Web browsers.
While WebSocket already is quite awesome, it is still low-level. Which is why we have WAMP. WAMP allows you to compose your application from loosely coupled components that talk in real-time with each other - using nice high-level communication patterns ("Remote Procedure Calls" and "Publish & Subscribe").
WAMP enables application architectures with application code distributed freely across processes and devices according to functional aspects. Since WAMP implementations exist for multiple languages, WAMP applications can be polyglot. Application components can be implemented in a language and run on a device which best fit the particular use case.
More:
Show me some code!
A sample WebSocket server:
class MyServerProtocol(WebSocketServerProtocol):
def onConnect(self, request):
print("Client connecting: {}".format(request.peer))
def onOpen(self):
print("WebSocket connection open.")
def onMessage(self, payload, isBinary):
if isBinary:
print("Binary message received: {} bytes".format(len(payload)))
else:
print("Text message received: {}".format(payload.decode('utf8')))
## echo back message verbatim
self.sendMessage(payload, isBinary)
def onClose(self, wasClean, code, reason):
print("WebSocket connection closed: {}".format(reason))Complete example code:
Introduction to WebSocket Programming with :
websocket/programming
A sample WAMP application component implementing all client roles:
class MyComponent(ApplicationSession):
@inlineCallbacks
def onJoin(self, details):
# 1) subscribe to a topic
def onevent(msg):
print("Got event: {}".format(msg))
yield self.subscribe(onevent, 'com.myapp.hello')
# 2) publish an event
self.publish('com.myapp.hello', 'Hello, world!')
# 3) register a procedure for remoting
def add2(x, y):
return x + y
self.register(add2, 'com.myapp.add2');
# 4) call a remote procedure
res = yield self.call('com.myapp.add2', 2, 3)
print("Got result: {}".format(res))Complete example code:
- server, which provides a remote procedure enpoint and publishes to a topic - Twisted - asyncio
- client, which calls the procedure and subscribes to the topic - Twisted - asyncio
Introduction to WAMP Programming with :
wamp/programming
Where to start
To get started, jump to installation.
For WebSocket developers, websocket/programming
explains all you need to know about using as a WebSocket library, and
includes a full reference for the relevant parts of the API.
websocket/examples
lists WebSocket code examples covering a broader range of uses cases and
advanced WebSocket features.
For WAMP developers, wamp/programming gives an introduction for programming
with WAMP in Python using .
wamp/examples lists
WAMP code examples covering all features of WAMP.
Community
Development of takes place on the Github source repository. We are open for contributions, whether that's code or documentation! We also take bug reports at the issue tracker.
The best place to ask questions about is on the mailing
list or on StackOverflow.
Questions on StackOverflow related to are tagged autobahn
(or autobahnws) and can be found here.
The best way to search the Web for related material is by using these search terms:
You can also reach users and developers on IRC channel
autobahn at freenode.net.
Finally, we are on Twitter.
installation websocket/programming wamp/programming websocket/examples wamp/examples reference/autobahn changelog