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`.`service``

module documentation
(source)

A module that needs a better name.

Implements new cred things for words.

How does this thing work?

- Network connection on some port expecting to speak some protocol
- Protocol-specific authentication, resulting in some kind of credentials object
- twisted.cred.portal login using those credentials for the interface IUser and with something implementing IChatClient as the mind
- successful login results in an IUser avatar the protocol can call methods on, and state added to the realm such that the mind will have methods called on it as is necessary
- protocol specific actions lead to calls onto the avatar; remote events lead to calls onto the mind
- protocol specific hangup, realm is notified, user is removed from active play, the end.

Class | `AvatarReference` | Undocumented
Class | `ChatAvatar` | Undocumented
Class | `Group` | Undocumented
Class | `InMemoryWordsRealm` | Undocumented
Class | `IRCFactory` | IRC server that creates instances of the `IRCUser` protocol.
Class | `IRCUser` | Protocol instance representing an IRC user connected to the server.
Class | `PBGroup` | Undocumented
Class | `PBGroupReference` | Undocumented
Class | `PBMind` | Undocumented
Class | `PBMindReference` | Undocumented
Class | `PBUser` | Undocumented
Class | `User` | Undocumented
Class | `WordsRealm` | No class docstring; 0/1 instance variable, 0/3 class variable, 2/14 methods documented
Constant | `NICKSERV` | Undocumented

NICKSERV: `str` = (source)

Undocumented

Value

    'NickServ!NickServ@services'