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`.`pair`.`tuntap`.`TunnelAddress``

class documentation

`class TunnelAddress(FancyStrMixin, FancyEqMixin): (source)`

Constructor: `TunnelAddress(type, name)`

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

View In Hierarchy

A `TunnelAddress` represents the tunnel to which a `TuntapPort` is bound.

Method | `__getitem__` | Deprecated accessor for the tunnel name. Use attributes instead.
Method | `__init__` | No summary
Class Variable | `compareAttributes` | Undocumented
Class Variable | `showAttributes` | Undocumented
Instance Variable | `name` | Undocumented
Instance Variable | `type` | Undocumented
Property | `_typeValue` | Return the integer value of the `type` attribute. Used to produce correct results in the equality implementation.

Inherited from `FancyStrMixin`:

Method | `__str__` | Undocumented

Inherited from `FancyEqMixin` (via `FancyStrMixin`):

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

def __getitem__(self, index): (source)

Deprecated accessor for the tunnel name. Use attributes instead.

def __init__(self, type, name): (source)

Parameters
type | Either `TunnelFlags.IFF_TUN` or `TunnelFlags.IFF_TAP`, representing the type of this tunnel.
name:`bytes` | The system name of the tunnel.

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

Undocumented

showAttributes = (source)
overrides `twisted.python.util.FancyStrMixin.showAttributes`

Undocumented

name = (source)

Undocumented

type = (source)

Undocumented

@property
_typeValue = (source)

Return the integer value of the `type` attribute. Used to produce correct results in the equality implementation.