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`.`ssh`.`address`.`SSHTransportAddress``

class documentation

`class SSHTransportAddress(util.FancyEqMixin): (source)`

Implements interfaces: `twisted.internet.interfaces.IAddress`

View In Hierarchy

Object representing an SSH Transport endpoint.

This is used to ensure that any code inspecting this address and attempting to construct a similar connection based upon it is not mislead into creating a transport which is not similar to the one it is indicating.

Method | `__hash__` | Undocumented
Method | `__init__` | Undocumented
Method | `__repr__` | Undocumented
Class Variable | `compareAttributes` | Undocumented
Instance Variable | `address` | An instance of an object which implements IAddress to which this transport address is connected.

Inherited from `FancyEqMixin`:

Method | `__eq__` | Undocumented
Method | `__ne__` | Undocumented

def __hash__(self): (source)

Undocumented

def __init__(self, address): (source)

Undocumented

def __repr__(self): (source)

Undocumented

Returns
`str` | Undocumented

compareAttributes: `tuple[str, ...]` = (source)
overrides `twisted.python.util.FancyEqMixin.compareAttributes`

Undocumented

address = (source)

An instance of an object which implements IAddress to which this transport address is connected.