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`.`IStreamClientEndpoint``

interface documentation

`class IStreamClientEndpoint(Interface): (source)`

Known implementations: `twisted.conch.endpoints.SSHCommandClientEndpoint`, `twisted.internet.endpoints.HostnameEndpoint`, `twisted.internet.endpoints.ProcessEndpoint`, `twisted.internet.endpoints.SSL4ClientEndpoint`, `twisted.internet.endpoints.TCP4ClientEndpoint`, `twisted.internet.endpoints.TCP6ClientEndpoint`, `twisted.internet.endpoints.UNIXClientEndpoint`, `twisted.internet.endpoints._WrapperEndpoint`

View In Hierarchy

A stream client endpoint is a place that `ClientFactory` can connect to. For example, a remote TCP host/port pair would be a TCP client endpoint.

Present Since
10.1

Method | `connect` | Connect the `protocolFactory` to the location specified by this `IStreamClientEndpoint` provider.

def connect(protocolFactory: `IProtocolFactory`) -> `Deferred[IProtocol]`: (source)

Connect the `protocolFactory` to the location specified by this `IStreamClientEndpoint` provider.

Parameters
protocolFactory:`IProtocolFactory` | A provider of `IProtocolFactory`
Returns
`Deferred[IProtocol]` | A `Deferred` that results in an `IProtocol` upon successful connection otherwise a `Failure` wrapping `ConnectError` or `NoProtocol`.