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

interface documentation

`class _ISSHConnectionCreator(Interface): (source)`

Known implementations: `twisted.conch.endpoints._ExistingConnectionHelper`, `twisted.conch.endpoints._NewConnectionHelper`

View In Hierarchy

An `_ISSHConnectionCreator` knows how to create SSH connections somehow.

Method | `cleanupConnection` | Perform cleanup necessary for a connection object previously returned from this creator's `secureConnection` method.
Method | `secureConnection` | Return a new, connected, secured, but not yet authenticated instance of `twisted.conch.ssh.transport.SSHServerTransport` or `twisted.conch.ssh.transport.SSHClientTransport`.

def cleanupConnection(connection, immediate): (source)

Perform cleanup necessary for a connection object previously returned from this creator's `secureConnection` method.

Parameters
connection | An `twisted.conch.ssh.transport.SSHServerTransport` or `twisted.conch.ssh.transport.SSHClientTransport` returned by a previous call to `secureConnection`. It is no longer needed by the caller of that method and may be closed or otherwise cleaned up as necessary.
immediate | If `True` don't wait for any network communication, just close the connection immediately and as aggressively as necessary.

def secureConnection(): (source)

Return a new, connected, secured, but not yet authenticated instance of `twisted.conch.ssh.transport.SSHServerTransport` or `twisted.conch.ssh.transport.SSHClientTransport`.