twisted.internet.tcp._BaseTCPClient : API documentation

class documentation

class _BaseTCPClient: (source)

Known subclasses: twisted.internet.iocpreactor.tcp.Client, twisted.internet.tcp.Client

Code shared with other (non-POSIX) reactors for management of outgoing TCP connections (both TCPv4 and TCPv6).

Note In order to be functional, this class must be mixed into the same hierarchy as _BaseBaseClient. It would subclass _BaseBaseClient directly, but the class hierarchy here is divided in strange ways out of the need to share code along multiple axes; specifically, with the IOCP reactor and also with UNIX clients in other reactors.

Instance Variable	`connector`	The `Connector` which is driving this `_BaseTCPClient`'s connection attempt.
Instance Variable	`addr`	The address that this socket will be connecting to.
Instance Variable	`createInternetSocket`	Subclasses must implement this as a method to create a python socket object of the appropriate address family and socket type.
Method	`__init__`	Undocumented
Instance Variable	`addressFamily`	Undocumented
Method	`getHost`	Returns an `IPv4Address` or `IPv6Address`.
Method	`getPeer`	Returns an `IPv4Address` or `IPv6Address`.
Method	`__repr__`	Undocumented
Instance Variable	`_addressType`	The Twisted _IPAddress implementation for this client
Instance Variable	`_requiresResolution`	Undocumented

_addressType = (source)

The Twisted _IPAddress implementation for this client

(type: IPv4Address or IPv6Address)

connector = (source)

The Connector which is driving this _BaseTCPClient's connection attempt.

addr = (source)

The address that this socket will be connecting to.

(type: If IPv4, a 2-tuple of (str host, int port). If IPv6, a 4-tuple of (str host, int port, int ignored, int scope).)

createInternetSocket = (source)

overridden in twisted.internet.iocpreactor.tcp.Client

Subclasses must implement this as a method to create a python socket object of the appropriate address family and socket type.

(type: 0-argument callable returning socket._socketobject.)

def __init__(self, host, port, bindAddress, connector, reactor=None): (source)

overridden in twisted.internet.iocpreactor.tcp.Client, twisted.internet.ssl.Client

Undocumented

_requiresResolution = (source)

Undocumented

(type: bool)

addressFamily = (source)

Undocumented

def getHost(self): (source)

Returns an IPv4Address or IPv6Address.

This indicates the address from which I am connecting.

def getPeer(self): (source)

Returns an IPv4Address or IPv6Address.

This indicates the address that I am connected to.

def __repr__(self): (source)

Undocumented

Returns Undocumented (type: str)

API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.