class documentation

class twisted.internet.endpoints.HostnameEndpoint: (source)

Implements interfaces: twisted.internet.interfaces.IStreamClientEndpoint

View In Hierarchy

A name-based endpoint that connects to the fastest amongst the resolved host addresses.

Method __init__ Create a HostnameEndpoint.
Method __repr__ Produce a string representation of the HostnameEndpoint.
Method connect Attempts a connection to each resolved address, and returns a connection which is established first.
Class Variable _DEFAULT_ATTEMPT_DELAY The default time to use between attempts, in seconds, when no attemptDelay is given to HostnameEndpoint.__init__.
Instance Variable _hostText the textual representation of the hostname passed to the constructor. Used to pass to the reactor's hostname resolver.
Instance Variable _hostBytes the encoded bytes-representation of the hostname passed to the constructor. Used to construct the HostnameAddress associated with this endpoint.
Instance Variable _hostStr the native-string representation of the hostname passed to the constructor, used for exception construction
Instance Variable _badHostname a flag - hopefully false! - indicating that an invalid hostname was passed to the constructor. This might be a textual hostname that isn't valid IDNA, or non-ASCII bytes.
Class Variable _getaddrinfo Undocumented
Class Variable _deferToThread Undocumented
Instance Variable _reactor Undocumented
Instance Variable _nameResolver Undocumented
Instance Variable _port Undocumented
Instance Variable _timeout Undocumented
Instance Variable _bindAddress Undocumented
Instance Variable _attemptDelay Undocumented
Method _getNameResolverAndMaybeWarn Retrieve a nameResolver callable and warn the caller's caller that using a reactor which doesn't provide IReactorPluggableNameResolver is deprecated.
Static Method _hostAsBytesAndText No summary
Method _fallbackNameResolution Resolve the hostname string into a tuple containing the host address. This is method is only used when the reactor does not provide IReactorPluggableNameResolver.
_DEFAULT_ATTEMPT_DELAY = (source)
The default time to use between attempts, in seconds, when no attemptDelay is given to HostnameEndpoint.__init__.
(type: float)
_hostText = (source)
the textual representation of the hostname passed to the constructor. Used to pass to the reactor's hostname resolver.
(type: unicode)
_hostBytes = (source)
the encoded bytes-representation of the hostname passed to the constructor. Used to construct the HostnameAddress associated with this endpoint.
(type: bytes)
_hostStr = (source)
the native-string representation of the hostname passed to the constructor, used for exception construction
(type: native str)
_badHostname = (source)
a flag - hopefully false! - indicating that an invalid hostname was passed to the constructor. This might be a textual hostname that isn't valid IDNA, or non-ASCII bytes.
(type: bool)
_getaddrinfo = (source)

Undocumented

_deferToThread = (source)

Undocumented

def __init__(self, reactor, host, port, timeout=30, bindAddress=None, attemptDelay=None): (source)

Create a HostnameEndpoint.

ParametersreactorThe reactor to use for connections and delayed calls. (type: provider of IReactorTCP, IReactorTime and either IReactorPluggableNameResolver or IReactorPluggableResolver.)
hostA hostname to connect to. (type: bytes or unicode)
portThe port number to connect to. (type: int)
timeoutFor each individual connection attempt, the number of seconds to wait before assuming the connection has failed. (type: float or int)
bindAddressthe local address of the network interface to make the connections from. (type: bytes)
attemptDelayThe number of seconds to delay between connection attempts. (type: float)
See Alsotwisted.internet.interfaces.IReactorTCP.connectTCP
_reactor = (source)

Undocumented

_nameResolver = (source)

Undocumented

_port = (source)

Undocumented

_timeout = (source)

Undocumented

_bindAddress = (source)

Undocumented

_attemptDelay = (source)

Undocumented

def __repr__(self): (source)

Produce a string representation of the HostnameEndpoint.

ReturnsA str (type: str)
def _getNameResolverAndMaybeWarn(self, reactor): (source)

Retrieve a nameResolver callable and warn the caller's caller that using a reactor which doesn't provide IReactorPluggableNameResolver is deprecated.

ParametersreactorThe reactor to check.
ReturnsA IHostnameResolver provider.
@staticmethod
def _hostAsBytesAndText(host): (source)

For various reasons (documented in the @ivar's in the class docstring) we need both a textual and a binary representation of the hostname given to the constructor. For compatibility and convenience, we accept both textual and binary representations of the hostname, save the form that was passed, and convert into the other form. This is mostly just because HostnameAddress chose somewhat poorly to define its attribute as bytes; hopefully we can find a compatible way to clean this up in the future and just operate in terms of text internally.

ParametershostA hostname to convert. (type: bytes or str)
Returnsa 3-tuple of (invalid, bytes, text) where invalid is a boolean indicating the validity of the hostname, bytes is a binary representation of host, and text is a textual representation of host.
def connect(self, protocolFactory): (source)

Attempts a connection to each resolved address, and returns a connection which is established first.

ParametersprotocolFactoryThe protocol factory whose protocol will be connected. (type: IProtocolFactory)
ReturnsA Deferred that fires with the connected protocol or fails a connection-related error.
def _fallbackNameResolution(self, host, port): (source)

Resolve the hostname string into a tuple containing the host address. This is method is only used when the reactor does not provide IReactorPluggableNameResolver.

ParametershostA unicode hostname to resolve.
portThe port to include in the resolution.
ReturnsA Deferred that fires with _getaddrinfo's return value.
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.