autobahn.asyncio¶

Submodules¶

autobahn.asyncio.wamp¶

class autobahn.asyncio.wamp.FutureMixin[source]¶

Mixin for Asyncio style Futures.

class autobahn.asyncio.wamp.ApplicationSession(config=None)[source]¶

Bases: autobahn.asyncio.wamp.FutureMixin, autobahn.wamp.protocol.ApplicationSession

WAMP application session for asyncio-based applications.

Constructor.

class autobahn.asyncio.wamp.ApplicationSessionFactory(config=None)[source]¶

Bases: autobahn.asyncio.wamp.FutureMixin, autobahn.wamp.protocol.ApplicationSessionFactory

WAMP application session factory for asyncio-based applications.

Parameters:	config (instance of autobahn.wamp.types.ComponentConfig) – The default component configuration.

session¶

The application session class this application session factory will use. Defaults to autobahn.asyncio.wamp.ApplicationSession.

alias of ApplicationSession

class autobahn.asyncio.wamp.ApplicationRunner(url, realm, extra=None, serializers=None, debug=False, debug_wamp=False, debug_app=False)[source]¶

This class is a convenience tool mainly for development and quick hosting of WAMP application components.

It can host a WAMP application component in a WAMP-over-WebSocket client connecting to a WAMP router.

Parameters:

url (unicode) – The WebSocket URL of the WAMP router to connect to (e.g. ws://somehost.com:8090/somepath) realm (unicode) – The WAMP realm to join the application session to. extra (dict) – Optional extra configuration to forward to the application component. serializers (list) – A list of WAMP serializers to use (or None for default serializers). Serializers must implement autobahn.wamp.interfaces.ISerializer. debug (bool) – Turn on low-level debugging. debug_wamp (bool) – Turn on WAMP-level debugging. debug_app (bool) – Turn on app-level debugging.

run(make)[source]¶

Run the application component.

Parameters:	make (callable) – A factory that produces instances of autobahn.asyncio.wamp.ApplicationSession when called with an instance of autobahn.wamp.types.ComponentConfig.

autobahn.asyncio.websocket¶

class autobahn.asyncio.websocket.WebSocketAdapterProtocol[source]¶

Bases: trollius.protocols.Protocol

Adapter class for asyncio-based WebSocket client and server protocols.

connection_made(transport)[source]¶

connection_lost(exc)[source]¶

data_received(data)[source]¶

registerProducer(producer, streaming)[source]¶

class autobahn.asyncio.websocket.WebSocketServerProtocol[source]¶

Bases: autobahn.asyncio.websocket.WebSocketAdapterProtocol, autobahn.websocket.protocol.WebSocketServerProtocol

Base class for asyncio-based WebSocket server protocols.

class autobahn.asyncio.websocket.WebSocketClientProtocol[source]¶

Bases: autobahn.asyncio.websocket.WebSocketAdapterProtocol, autobahn.websocket.protocol.WebSocketClientProtocol

Base class for asyncio-based WebSocket client protocols.

class autobahn.asyncio.websocket.WebSocketAdapterFactory[source]¶

Adapter class for asyncio-based WebSocket client and server factories.

class autobahn.asyncio.websocket.WebSocketServerFactory(*args, **kwargs)[source]¶

Bases: autobahn.asyncio.websocket.WebSocketAdapterFactory, autobahn.websocket.protocol.WebSocketServerFactory

Base class for asyncio-based WebSocket server factories.

In addition to all arguments to the constructor of autobahn.websocket.protocol.WebSocketServerFactory, you can supply a loop keyword argument to specify the asyncio event loop to be used.

class autobahn.asyncio.websocket.WebSocketClientFactory(*args, **kwargs)[source]¶

Bases: autobahn.asyncio.websocket.WebSocketAdapterFactory, autobahn.websocket.protocol.WebSocketClientFactory

Base class for asyncio-baseed WebSocket client factories.

In addition to all arguments to the constructor of autobahn.websocket.protocol.WebSocketClientFactory, you can supply a loop keyword argument to specify the asyncio event loop to be used.

class autobahn.asyncio.websocket.WampWebSocketServerProtocol[source]¶

Bases: autobahn.wamp.websocket.WampWebSocketServerProtocol, autobahn.asyncio.websocket.WebSocketServerProtocol

Base class for asyncio-based WAMP-over-WebSocket server protocols.

class autobahn.asyncio.websocket.WampWebSocketServerFactory(factory, *args, **kwargs)[source]¶

Bases: autobahn.wamp.websocket.WampWebSocketServerFactory, autobahn.asyncio.websocket.WebSocketServerFactory

Base class for asyncio-based WAMP-over-WebSocket server factories.

protocol¶

alias of WampWebSocketServerProtocol

class autobahn.asyncio.websocket.WampWebSocketClientProtocol[source]¶

Bases: autobahn.wamp.websocket.WampWebSocketClientProtocol, autobahn.asyncio.websocket.WebSocketClientProtocol

Base class for asyncio-based WAMP-over-WebSocket client protocols.

class autobahn.asyncio.websocket.WampWebSocketClientFactory(factory, *args, **kwargs)[source]¶

Bases: autobahn.wamp.websocket.WampWebSocketClientFactory, autobahn.asyncio.websocket.WebSocketClientFactory

Base class for asyncio-based WAMP-over-WebSocket client factories.

protocol¶

alias of WampWebSocketClientProtocol

Module contents¶