Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`words`.`protocols`.`jabber`.`component`.`XMPPComponentServerFactory``

class documentation

`class XMPPComponentServerFactory(xmlstream.XmlStreamServerFactory): (source)`

View In Hierarchy

XMPP Component Server factory.

This factory accepts XMPP external component connections and makes the router service route traffic for a component's bound domain to that component.

Present Since
8.2

Method | `__init__` | Undocumented
Method | `onAuthenticated` | Called when a component has successfully authenticated.
Method | `onConnectionLost` | Undocumented
Method | `onConnectionMade` | Called when a component connection was made.
Method | `onError` | Undocumented
Class Variable | `logTraffic` | Undocumented
Instance Variable | `router` | Undocumented
Instance Variable | `secret` | Undocumented
Instance Variable | `serial` | Undocumented

Inherited from `XmlStreamServerFactory`:

Method | `buildProtocol` | Create an instance of XmlStream.
Instance Variable | `authenticatorFactory` | Factory callable that takes no arguments, to create a fresh authenticator to be associated with the XmlStream.

Inherited from `BootstrapMixin` (via `XmlStreamServerFactory`):

Method | `addBootstrap` | Add a bootstrap event handler.
Method | `installBootstraps` | Install registered bootstrap observers.
Method | `removeBootstrap` | Remove a bootstrap event handler.
Instance Variable | `bootstraps` | The list of registered bootstrap event observers.

Inherited from `Factory` (via `XmlStreamServerFactory`, `BootstrapMixin`, `ServerFactory`):

Class Method | `forProtocol` | Create a factory for the given protocol.
Method | `doStart` | Make sure startFactory is called.
Method | `doStop` | Make sure stopFactory is called.
Method | `logPrefix` | Describe this factory for log messages.
Method | `startFactory` | This will be called before I begin listening on a Port or Connector.
Method | `stopFactory` | This will be called before I stop listening on all Ports/Connectors.
Class Variable | `noisy` | Undocumented
Class Variable | `protocol` | Undocumented
Instance Variable | `numPorts` | Undocumented

def __init__(self, router, secret='secret'): (source)
overrides `twisted.words.protocols.jabber.xmlstream.XmlStreamServerFactory.__init__`

Undocumented

def onAuthenticated(self, xs): (source)

Called when a component has successfully authenticated.

Add the component to the routing table and establish a handler for a closed connection.

def onConnectionLost(self, destination, xs, reason): (source)

Undocumented

def onConnectionMade(self, xs): (source)

Called when a component connection was made.

This enables traffic debugging on incoming streams.

def onError(self, reason): (source)

Undocumented

logTraffic: `bool` = (source)

Undocumented

router = (source)

Undocumented

secret = (source)

Undocumented

serial: `int` = (source)

Undocumented