twisted.internet.interfaces.IStreamClientEndpoint

interface documentation

class IStreamClientEndpoint(Interface): (source)

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

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 Since10.1
Method connect Connect the protocolFactory to the location specified by this IStreamClientEndpoint provider.
def connect(protocolFactory): (source)

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

ParametersprotocolFactoryA provider of IProtocolFactory (type: IProtocolFactory)
ReturnsA Deferred that results in an IProtocol upon successful connection otherwise a Failure wrapping ConnectError or NoProtocol. (type: Deferred)
API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.