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`.`spread`.`pb`.`PBServerFactory``

class documentation

`class PBServerFactory(protocol.ServerFactory): (source)`

View In Hierarchy

Server factory for perspective broker.

Login is done using a Portal object, whose realm is expected to return avatars implementing IPerspective. The credential checkers in the portal should accept IUsernameHashedPassword or IUsernameMD5Password.

Alternatively, any object providing or adaptable to `IPBRoot` can be used instead of a portal to provide the root object of the PB server.

Method | `__init__` | No summary
Method | `buildProtocol` | Return a Broker attached to the factory (as the service provider).
Method | `clientConnectionMade` | Undocumented
Instance Variable | `root` | Undocumented
Instance Variable | `security` | Undocumented
Instance Variable | `unsafeTracebacks` | Undocumented

Inherited from `Factory` (via `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, root, unsafeTracebacks=False, security=globalSecurity): (source)

Parameters
root:object providing or adaptable to `IPBRoot`. | factory providing the root Referenceable used by the broker.
unsafeTracebacks:`bool` | if set, tracebacks for exceptions will be sent over the wire.
security:`twisted.spread.jelly.SecurityOptions` | security options used by the broker, default to `globalSecurity`.

def buildProtocol(self, addr): (source)
from `twisted.internet.interfaces.IProtocolFactory`
overrides `twisted.internet.protocol.Factory.buildProtocol`

Return a Broker attached to the factory (as the service provider).

def clientConnectionMade(self, protocol): (source)

Undocumented

root = (source)

Undocumented

security = (source)

Undocumented

unsafeTracebacks = (source)

Undocumented