twisted.internet.tcp.Connection

class documentation

class Connection(_TLSConnectionMixin, abstract.FileDescriptor, _SocketCloser, _AbortingMixin): (source)

Known subclasses: twisted.internet.tcp.BaseClient, twisted.internet.tcp.Server

Implements interfaces: twisted.internet.interfaces.ISystemHandle, twisted.internet.interfaces.ITCPTransport, zope.interface.Interface

View In Hierarchy

Superclass of all socket-based FileDescriptors.

This is an abstract superclass of all objects which represent a TCP/IP connection based socket.

Instance Variable logstr prefix used when logging events related to this connection.
Method __init__
Instance Variable socket Undocumented
Instance Variable protocol Undocumented
Method getHandle Return the socket for this connection.
Method doRead Calls self.protocol.dataReceived with all available data.
Method writeSomeData Write as much as possible of the given data to this TCP connection.
Method readConnectionLost Indicates read connection was lost.
Method connectionLost See abstract.FileDescriptor.connectionLost().
Method logPrefix Return the prefix to log with when I own the logging thread.
Method getTcpNoDelay Return if TCP_NODELAY is enabled.
Method setTcpNoDelay Enable/disable TCP_NODELAY.
Method getTcpKeepAlive Return if SO_KEEPALIVE is enabled.
Method setTcpKeepAlive Enable/disable SO_KEEPALIVE.
Method _dataReceived Undocumented
Method _closeWriteConnection Undocumented

Inherited from _TLSConnectionMixin:

Class Variable TLS Undocumented

Inherited from FileDescriptor:

Instance Variable connected Undocumented
Instance Variable disconnected Undocumented
Instance Variable disconnecting Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable offset Undocumented
Class Variable SEND_LIMIT Undocumented
Instance Variable reactor Undocumented
Instance Variable producer Undocumented
Method doWrite Called when data can be written.
Instance Variable producerPaused Undocumented
Method writeConnectionLost Indicates write connection was lost.
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method getPeer Get the remote address of this connection.
Method write Reliably write some data.
Method writeSequence Reliably write a sequence of data.
Method loseConnection Close the connection at the next available opportunity.
Method loseWriteConnection Undocumented
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Class Variable bufferSize Undocumented
Method stopConsuming Stop consuming data.
Method resumeProducing Resume producing data.
Method pauseProducing Pause producing data.
Method stopProducing Stop producing data.
Method fileno File Descriptor number for select().
Instance Variable _writeDisconnecting Undocumented
Instance Variable _writeDisconnected Undocumented
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Method _isSendBufferFull Determine whether the user-space send buffer for this transport is full or not.
Method _maybePauseProducer Possibly pause a producer, if there is one and the send buffer is full.

Inherited from _ConsumerMixin (via FileDescriptor):

Instance Variable streamingProducer bool or int
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.

Inherited from _LogOwner (via FileDescriptor):

Method _getLogPrefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.

Inherited from _SocketCloser:

Instance Variable _shouldShutdown Set to True if shutdown should be called before calling close on the underlying socket.
Method _closeSocket Undocumented

Inherited from _AbortingMixin:

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable doWrite Undocumented
Instance Variable _aborting Set to True when abortConnection is called.
logstr = (source)
overridden in twisted.internet.tcp.BaseClient, twisted.internet.tcp.Server
prefix used when logging events related to this connection.
(type: str)
def __init__(self, skt, protocol, reactor=None): (source)
overrides twisted.internet.abstract.FileDescriptor.__init__
overridden in twisted.internet.ssl.Client, twisted.internet.tcp.Server, twisted.internet.unix.Client
ParameterssktUndocumented
protocolUndocumented
reactorAn IReactorFDSet provider which this descriptor will use to get readable and writeable event notifications. If no value is given, the global reactor will be used.
socket = (source)

Undocumented

protocol = (source)
overridden in twisted.internet.tcp.BaseClient

Undocumented

def getHandle(self): (source)
from twisted.internet.interfaces.ISystemHandle

Return the socket for this connection.

def doRead(self): (source)
from twisted.internet.interfaces.IReadDescriptor
overrides twisted.internet.abstract.FileDescriptor.doRead

Calls self.protocol.dataReceived with all available data.

This reads up to self.bufferSize bytes of data from its socket, then calls self.dataReceived(data) to process it. If the connection is not lost through an error in the physical recv(), this function will return the result of the dataReceived call.

def _dataReceived(self, data): (source)

Undocumented

def writeSomeData(self, data): (source)
overrides twisted.internet.abstract.FileDescriptor.writeSomeData

Write as much as possible of the given data to this TCP connection.

This sends up to self.SEND_LIMIT bytes from data. If the connection is lost, an exception is returned. Otherwise, the number of bytes successfully written is returned.

def _closeWriteConnection(self): (source)
overrides twisted.internet.abstract.FileDescriptor._closeWriteConnection

Undocumented

def readConnectionLost(self, reason): (source)
from twisted.internet.interfaces.IHalfCloseableDescriptor
overrides twisted.internet.abstract.FileDescriptor.readConnectionLost

Indicates read connection was lost.

def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IFileDescriptor
overrides twisted.internet.abstract.FileDescriptor.connectionLost

See abstract.FileDescriptor.connectionLost().

def logPrefix(self): (source)
from twisted.internet.interfaces.ILoggingContext
overrides twisted.internet.abstract._LogOwner.logPrefix

Return the prefix to log with when I own the logging thread.

def getTcpNoDelay(self): (source)
from twisted.internet.interfaces.ITCPTransport

Return if TCP_NODELAY is enabled.

def setTcpNoDelay(self, enabled): (source)
from twisted.internet.interfaces.ITCPTransport

Enable/disable TCP_NODELAY.

Enabling TCP_NODELAY turns off Nagle's algorithm. Small packets are sent sooner, possibly at the expense of overall throughput.

def getTcpKeepAlive(self): (source)
from twisted.internet.interfaces.ITCPTransport

Return if SO_KEEPALIVE is enabled.

def setTcpKeepAlive(self, enabled): (source)
from twisted.internet.interfaces.ITCPTransport

Enable/disable SO_KEEPALIVE.

Enabling SO_KEEPALIVE sends packets periodically when the connection is otherwise idle, usually once every two hours. They are intended to allow detection of lost peers in a non-infinite amount of time.

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