twisted.internet.tcp._BaseTCPClient(object) class documentation

Part of twisted.internet.tcp View Source (View In Hierarchy)

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).

NoteIn 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. (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).)
Instance Variable createInternetSocket 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.)
Method __init__ 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 (type: IPv4Address or IPv6Address)
_addressType =
The Twisted _IPAddress implementation for this client (type: IPv4Address or IPv6Address)
connector =
The Connector which is driving this _BaseTCPClient's connection attempt.
addr =
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 =
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
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
API Documentation for Twisted, generated by pydoctor at 2017-09-23 19:45:03.