crossbar.common.twisted.endpoint

Functions

create_connecting_endpoint_from_config(config, cbdir, ...)

Create a Twisted stream client endpoint from a Crossbar.io transport configuration.

create_connecting_port_from_config(config, cbdir, ...)

Create a Twisted connecting port from a Crossbar.io transport configuration.

create_listening_endpoint_from_config(config, cbdir, ...)

Create a Twisted stream server endpoint from a Crossbar.io transport configuration.

create_listening_port_from_config(config, cbdir, ...)

Create a Twisted listening port from a Crossbar.io transport configuration.

Module Contents

create_connecting_endpoint_from_config(config, cbdir, reactor, log)[source]

Create a Twisted stream client endpoint from a Crossbar.io transport configuration.

See: https://twistedmatrix.com/documents/current/api/twisted.internet.interfaces.IStreamClientEndpoint.html

Parameters:

  • config (dict) – The transport configuration.

  • cbdir (str) – Crossbar.io node directory (we need this for Unix domain socket paths and TLS key/certificates).

  • reactor (obj) – The reactor to use for endpoint creation.

:returns obj – An instance implementing IStreamClientEndpoint

create_connecting_port_from_config(config, cbdir, factory, reactor, log)[source]

Create a Twisted connecting port from a Crossbar.io transport configuration.

See: https://twistedmatrix.com/documents/current/api/twisted.internet.interfaces.IListeningPort.html

Parameters:

  • config (dict) – The transport configuration.

  • factory (obj) – The transport factory to use (a provider of IProtocolFactory).

  • cbdir (str) – Crossbar.io node directory (we need this for Unix domain socket paths and TLS key/certificates).

  • reactor (obj) – The reactor to use for endpoint creation.

:returns obj – A Deferred that results in an IProtocol upon successful connection otherwise a ConnectError

create_listening_endpoint_from_config(config, cbdir, reactor, log)[source]

Create a Twisted stream server endpoint from a Crossbar.io transport configuration.

See: https://twistedmatrix.com/documents/current/api/twisted.internet.interfaces.IStreamServerEndpoint.html

Parameters:

  • config (dict) – The transport configuration.

  • cbdir (str) – Crossbar.io node directory (we need this for TLS key/certificates).

  • reactor (obj) – The reactor to use for endpoint creation.

:returns obj – An instance implementing IStreamServerEndpoint

create_listening_port_from_config(config, cbdir, factory, reactor, log, max_connections=None, name=None)[source]

Create a Twisted listening port from a Crossbar.io transport configuration.

See: https://twistedmatrix.com/documents/current/api/twisted.internet.interfaces.IListeningPort.html

Parameters:

  • config (dict) – The transport configuration.

  • factory (obj) – The transport factory to use (a provider of IProtocolFactory).

  • cbdir (str) – Crossbar.io node directory (we need this for TLS key/certificates).

  • reactor (obj) – The reactor to use for endpoint creation.

  • max_connections (int or None) – When set, the port refuses connections while this many are open.

  • name (str or None) – The name of the listening port in log messages.

:returns obj – A Deferred that results in an IListeningPort or an CannotListenError