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`.`interfaces`.`IHandshakeListener``

interface documentation

`class IHandshakeListener(Interface): (source)`

View In Hierarchy

An interface implemented by a `IProtocol` to indicate that it would like to be notified when TLS handshakes complete when run over a TLS-based transport.

This interface is only guaranteed to be called when run over a TLS-based transport: non TLS-based transports will not respect this interface.

Method | `handshakeCompleted` | Notification of the TLS handshake being completed.

def handshakeCompleted(): (source)

Notification of the TLS handshake being completed.

This notification fires when OpenSSL has completed the TLS handshake. At this point the TLS connection is established, and the protocol can interrogate its transport (usually an `ISSLTransport`) for details of the TLS connection.

This notification *also* fires whenever the TLS session is renegotiated. As a result, protocols that have certain minimum security requirements should implement this interface to ensure that they are able to re-evaluate the security of the TLS session if it changes.