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`.`conch`.`endpoints``

module documentation
(source)

Endpoint implementations of various SSH interactions.

Class | `SSHCommandAddress` | An `SSHCommandAddress` instance represents the address of an SSH server, a username which was used to authenticate with that server, and a command which was run there.
Class | `SSHCommandClientEndpoint` | `SSHCommandClientEndpoint` exposes the command-executing functionality of SSH servers.
Exception | `AuthenticationFailed` | An SSH session could not be established because authentication was not successful.
Interface | `_ISSHConnectionCreator` | An `_ISSHConnectionCreator` knows how to create SSH connections somehow.
Class | `_CommandChannel` | A `_CommandChannel` executes a command in a session channel and connects its input and output to an `IProtocol` provider.
Class | `_CommandTransport` | `_CommandTransport` is an SSH client transport which includes a host key verification step before it will proceed to secure the connection.
Class | `_ConnectionReady` | `_ConnectionReady` is an `SSHConnection` (an SSH service) which only propagates the serviceStarted event to a `Deferred` to be handled elsewhere.
Class | `_ExistingConnectionHelper` | `_ExistingConnectionHelper` implements `_ISSHConnectionCreator` by handing out an existing SSH connection which is supplied to its initializer.
Class | `_NewConnectionHelper` | `_NewConnectionHelper` implements `_ISSHConnectionCreator` by establishing a brand new SSH connection, securing it, and authenticating.
Class | `_ReadFile` | A weakly file-like object which can be used with `KnownHostsFile` to respond in the negative to all prompts for decisions.
Class | `_UserAuth` | `_UserAuth` implements the client part of SSH user authentication in the convenient way a user might expect if they are familiar with the interactive ssh command line client.