Skip to main content

WebSocket client & server library, WAMP real-time framework

Project description

WebSocket & WAMP for Python on Twisted and asyncio.

Version Build Status Coverage Docs Docker

Introduction

Autobahn|Python is a subproject of Autobahn and provides open-source implementations of

for Python 2 and 3, and running on Twisted and asyncio.

You can use Autobahn|Python to create clients and servers in Python speaking just plain WebSocket or WAMP.

WebSocket allows bidirectional real-time messaging on the Web and beyond, while WAMP adds real-time application communication on top of WebSocket.

WAMP provides asynchronous Remote Procedure Calls and Publish & Subscribe for applications in one protocol running over WebSocket. WAMP is a routed protocol, so you need a WAMP Router to connect your Autobahn|Python based clients. We provide Crossbar.io, but there are other options as well.

Features

Native vector extensions (NVX)

Autobahn contains NVX, a network accelerator library that provides SIMD accelerated native vector code for WebSocket (XOR masking) and UTF-8 validation.

> NVX lives in namespace autobahn.nvx and currently requires a x86-86 CPU with at least SSE2 and makes use of SSE4.1 if available. The code is written using vector instrinsics, should compile with both GCC and Clang,and interfaces with Python using CFFI, and hence runs fast on PyPy.

Show me some code

To give you a first impression, here are two examples. We have lot more in the repo.

WebSocket Echo Server

Here is a simple WebSocket Echo Server that will echo back any WebSocket message received:

from autobahn.twisted.websocket import WebSocketServerProtocol
# or: from autobahn.asyncio.websocket import WebSocketServerProtocol

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))

To actually run above server protocol, you need some lines of boilerplate.

WAMP Application Component

Here is a WAMP Application Component that performs all four types of actions that WAMP provides:

  1. subscribe to a topic

  2. publish an event

  3. register a procedure

  4. call a procedure

from autobahn.twisted.wamp import ApplicationSession
# or: from autobahn.asyncio.wamp import ApplicationSession

class MyComponent(ApplicationSession):

    @inlineCallbacks
    def onJoin(self, details):

        # 1. subscribe to a topic so we receive events
        def onevent(msg):
            print("Got event: {}".format(msg))

        yield self.subscribe(onevent, 'com.myapp.hello')

        # 2. publish an event to a topic
        self.publish('com.myapp.hello', 'Hello, world!')

        # 3. register a procedure for remote calling
        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))

Above code will work on Twisted and asyncio by changing a single line (the base class of MyComponent). To actually run above application component, you need some lines of boilerplate and a WAMP Router.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autobahn-18.6.1.tar.gz (225.0 kB view details)

Uploaded Source

Built Distribution

autobahn-18.6.1-py2.py3-none-any.whl (294.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file autobahn-18.6.1.tar.gz.

File metadata

  • Download URL: autobahn-18.6.1.tar.gz
  • Upload date:
  • Size: 225.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for autobahn-18.6.1.tar.gz
Algorithm Hash digest
SHA256 2f41bfc512ec482044fa8cfa74182118dedd87e03b3494472d9ff1b5a1e27d24
MD5 fcf886ecec48204faaa77441eaef3a17
BLAKE2b-256 e0a4ca655f7fc8cc28274f7415a304e73c525b203828c164cea22e60207afea0

See more details on using hashes here.

File details

Details for the file autobahn-18.6.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for autobahn-18.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 83e050f0e0783646dbf6da60fe837f4f825c241080d2b5f080002ae6885b036f
MD5 b181277069d0bf72e205340808eef3cd
BLAKE2b-256 c97a140264ec2c162bb22f91be76a11554f8ab0eda9bb2c775b6bc0dbbef0d4a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page