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`.`internet`.`_newtls`.`_BypassTLS``

class documentation

`class _BypassTLS: (source)`

View In Hierarchy

`_BypassTLS` is used as the transport object for the TLS protocol object used to implement `startTLS`. Its methods skip any TLS logic which `startTLS` enables.

Method | `__getattr__` | Forward any extra attribute access to the original transport object. For example, this exposes `getHost`, the behavior of which does not change after TLS is enabled.
Method | `__init__` | Undocumented
Method | `loseConnection` | Close the underlying connection.
Method | `registerProducer` | Register a producer with the underlying connection.
Method | `unregisterProducer` | Unregister a producer with the underlying connection.
Method | `write` | Write some bytes directly to the connection.
Method | `writeSequence` | Write a some bytes directly to the connection.
Instance Variable | `_base` | A transport class `_BypassTLS` has been mixed in with to which methods will be forwarded. This class is only responsible for sending bytes over the connection, not doing TLS.
Instance Variable | `_connection` | A `Connection` which TLS has been started on which will be proxied to by this object. Any method which has its behavior altered after `startTLS` will be skipped in favor of the base class's implementation...

def __getattr__(self, name): (source)

Forward any extra attribute access to the original transport object. For example, this exposes `getHost`, the behavior of which does not change after TLS is enabled.

def __init__(self, base, connection): (source)

Undocumented

def loseConnection(self, *args, **kwargs): (source)

Close the underlying connection.

def registerProducer(self, producer, streaming): (source)

Register a producer with the underlying connection.

def unregisterProducer(self): (source)

Unregister a producer with the underlying connection.

def write(self, data): (source)

Write some bytes directly to the connection.

def writeSequence(self, iovec): (source)

Write a some bytes directly to the connection.

_base = (source)

A transport class `_BypassTLS` has been mixed in with to which methods will be forwarded. This class is only responsible for sending bytes over the connection, not doing TLS.

_connection = (source)

A `Connection` which TLS has been started on which will be proxied to by this object. Any method which has its behavior altered after `startTLS` will be skipped in favor of the base class's implementation. This allows the TLS protocol object to have direct access to the transport, necessary to actually implement TLS.