autobahn.twisted¶

Submodules¶

Classes¶

`ApplicationSession`	WAMP application session for Twisted-based applications.
`WebSocketClientFactory`	Base class for Twisted-based WebSocket client factories.
`WebSocketClientProtocol`	Base class for Twisted-based WebSocket client protocols.
`WebSocketServerFactory`	Base class for Twisted-based WebSocket server factories.
`WebSocketServerProtocol`	Base class for Twisted-based WebSocket server protocols.
`WrappingWebSocketServerFactory`	Wrapping server factory for stream-based transport over WebSocket.

Functions¶

`install_reactor`([explicit_reactor, verbose, log, ...])	Install Twisted reactor.
`sleep`(delay[, reactor])	Inline sleep for use in co-routines (Twisted `inlineCallback` decorated functions).

Package Contents¶

class ApplicationSession(config: autobahn.wamp.types.ComponentConfig | None = None)[source]¶

Bases: autobahn.wamp.protocol.ApplicationSession

WAMP application session for Twisted-based applications.

Implements:

autobahn.wamp.interfaces.ITransportHandler

autobahn.wamp.interfaces.ISession

log¶

class WebSocketClientFactory(*args, **kwargs)[source]¶

Bases: WebSocketAdapterFactory, autobahn.websocket.protocol.WebSocketClientFactory, twisted.internet.protocol.ClientFactory

Base class for Twisted-based WebSocket client factories.

Implements autobahn.websocket.interfaces.IWebSocketClientChannelFactory

log¶

reactor¶

class WebSocketClientProtocol[source]¶

Bases: WebSocketAdapterProtocol, autobahn.websocket.protocol.WebSocketClientProtocol

Base class for Twisted-based WebSocket client protocols.

Implements autobahn.websocket.interfaces.IWebSocketChannel.

_onConnect(response: autobahn.websocket.types.ConnectionResponse)[source]¶

is_server = False¶

log¶

startTLS()[source]¶

class WebSocketServerFactory(*args, **kwargs)[source]¶

Bases: WebSocketAdapterFactory, autobahn.websocket.protocol.WebSocketServerFactory, twisted.internet.protocol.ServerFactory

Base class for Twisted-based WebSocket server factories.

Implements autobahn.websocket.interfaces.IWebSocketServerChannelFactory

log¶

reactor¶

class WebSocketServerProtocol[source]¶

Bases: WebSocketAdapterProtocol, autobahn.websocket.protocol.WebSocketServerProtocol

Base class for Twisted-based WebSocket server protocols.

Implements autobahn.websocket.interfaces.IWebSocketChannel.

is_server = True¶

log¶

class WrappingWebSocketServerFactory(factory, url, reactor=None, enableCompression=True, autoFragmentSize=0, subprotocol=None)[source]¶

Bases: WebSocketServerFactory

Wrapping server factory for stream-based transport over WebSocket.

_factory¶

_subprotocols = ['binary', 'base64']¶

buildProtocol(addr)[source]¶

startFactory()[source]¶

stopFactory()[source]¶

install_reactor(explicit_reactor=None, verbose=False, log=None, require_optimal_reactor=True)[source]¶

Install Twisted reactor.

Parameters:

explicit_reactor (obj) – If provided, install this reactor. Else, install the optimal reactor.
verbose (bool) – If True, log (at level “info”) the reactor that is in place afterwards.
log (obj) – Explicit logging to this txaio logger object.
require_optimal_reactor (bool) – If True and the desired reactor could not be installed, raise ReactorAlreadyInstalledError, else fallback to another reactor.

Returns:

The Twisted reactor in place (twisted.internet.reactor).

sleep(delay, reactor=None)[source]¶

Inline sleep for use in co-routines (Twisted inlineCallback decorated functions).