twisted.internet.tcp

Various asynchronous TCP/IP classes.

End users shouldn't use this module directly - use the reactor APIs instead.

Class	Connection	Superclass of all socket-based FileDescriptors.
Class	BaseClient	A base class for client TCP (and similar) sockets.
Class	Client	A transport for a TCP protocol; either TCPv4 or TCPv6.
Class	Server	Serverside socket-stream connection class.
Class	Port	A TCP server port, listening for connections.
Class	Connector	A `Connector` provides of `twisted.internet.interfaces.IConnector` for all POSIX-style reactors.
Class	_TLSConnectionMixin	Undocumented
Class	_TLSClientMixin	Undocumented
Class	_TLSServerMixin	Undocumented
Function	_getrealname	No summary
Function	_getpeername	See `_getrealname`.
Function	_getsockname	See `_getrealname`.
Class	_SocketCloser
Class	_AbortingMixin	Common implementation of `abortConnection`.
Class	_BaseBaseClient	Code shared with other (non-POSIX) reactors for management of general outgoing connections.
Function	_resolveIPv6	Resolve an IPv6 literal into an IPv6 address.
Class	_BaseTCPClient	Code shared with other (non-POSIX) reactors for management of outgoing TCP connections (both TCPv4 and TCPv6).
Interface	_IFileDescriptorReservation	No summary
Class	_FileDescriptorReservation	`_IFileDescriptorReservation` implementation.
Class	_NullFileDescriptorReservation	A null implementation of `_IFileDescriptorReservation`.
Class	_BuffersLogs	A context manager that buffers any log events until after its block exits.
Function	_accept	Return a generator that yields client sockets from the provided listening socket until there are none left or an unrecoverable error occurs.

def _getrealname(addr):

Return a 2-tuple of socket IP and port for IPv4 and a 4-tuple of socket IP, port, flowInfo, and scopeID for IPv6. For IPv6, it returns the interface portion (the part after the %) as a part of the IPv6 address, which Python 3.7+ does not include.

Parameters addr A 2-tuple for IPv4 information or a 4-tuple for IPv6 information.

def _getpeername(skt):

See _getrealname.

def _getsockname(skt):

See _getrealname.

def _resolveIPv6(ip, port):

Resolve an IPv6 literal into an IPv6 address.

This is necessary to resolve any embedded scope identifiers to the relevant sin6_scope_id for use with socket.connect(), socket.listen(), or socket.bind(); see RFC 3493 for more information.

Parameters	ip	An IPv6 address literal. (type: `str`)
	port	A port number. (type: `int`)
Returns	a 4-tuple of `(host, port, flow, scope)`, suitable for use as an IPv6 address.
Raises	socket.gaierror	if either the IP or port is not numeric as it should be.

def _accept(logger, accepts, listener, reservedFD):

Return a generator that yields client sockets from the provided listening socket until there are none left or an unrecoverable error occurs.

Parameters	logger	A logger to which `accept`-related events will be logged. This should not log to arbitrary observers that might open a file descriptor to avoid claiming the `EMFILE` file descriptor on UNIX-like systems. (type: `Logger`)
	accepts	An iterable iterated over to limit the number consecutive `accept`s. (type: An iterable.)
	listener	The listening socket. (type: `socket.socket`)
	reservedFD	A reserved file descriptor that can be used to recover from `EMFILE` on UNIX-like systems. (type: `_IFileDescriptorReservation`)
Returns	A generator that yields `(socket, addr)` tuples from `socket.socket.accept`

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.

twisted.internet.tcp module documentation

`twisted.internet.tcp` module documentation