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`.`endpoints`.`_TLSClientEndpointParser``

class documentation

`class _TLSClientEndpointParser: (source)`

Implements interfaces: `twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor`, `twisted.plugin.IPlugin`

View In Hierarchy

Stream client endpoint string parser for `wrapClientTLS` with `HostnameEndpoint`.

Static Method | `parseStreamClient` | Redirects to another function `_parseClientTLS`; tricks zope.interface into believing the interface is correctly implemented, since the signature is (`reactor`, `*args`, `**kwargs`). See `_parseClientTLS` for the specific signature description for this endpoint parser.
Instance Variable | `prefix` | See `IStreamClientEndpointStringParserWithReactor.prefix`.

@staticmethod
def parseStreamClient(reactor, *args, **kwargs): (source)
from `twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor`

Redirects to another function `_parseClientTLS`; tricks zope.interface into believing the interface is correctly implemented, since the signature is (`reactor`, `*args`, `**kwargs`). See `_parseClientTLS` for the specific signature description for this endpoint parser.

Parameters
reactor | The reactor passed to `clientFromString`.
*args:`tuple` | The positional arguments in the endpoint description.
**kwargs:`dict` | The named arguments in the endpoint description.
Returns
`IStreamClientEndpoint` | a client TLS endpoint

prefix: `str` = (source)
from `twisted.internet.interfaces.IStreamClientEndpointStringParserWithReactor`

See `IStreamClientEndpointStringParserWithReactor.prefix`.