twisted.internet.tcp.Connection

class documentation

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

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

Constructor: Connection(skt, protocol, reactor)

Implements interfaces: twisted.internet.interfaces.ISystemHandle, twisted.internet.interfaces.ITCPTransport, twisted.internet.interfaces.ITLSTransport

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.

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

Inherited from ConnectionMixin:

Method loseConnection Close this connection after writing all pending data.
Method registerProducer Register a producer.
Method startTLS No summary
Method unregisterProducer Unregister a producer.
Method write Write some bytes to this connection, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
Method writeSequence Write some bytes to this connection, scatter/gather-style, passing them through a TLS layer if necessary, or discarding them if the connection has already been lost.
Constant TLS A flag indicating whether TLS is currently in use on this transport. This is not a good way for applications to check for TLS, instead use twisted.internet.interfaces.ISSLTransport.

Inherited from FileDescriptor (via ConnectionMixin):

Method doWrite Called when data can be written.
Method fileno File Descriptor number for select().
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 loseWriteConnection Undocumented
Method pauseProducing Pause producing data.
Method resumeProducing Resume producing data.
Method startReading Start waiting for read availability.
Method startWriting Start waiting for write availability.
Method stopConsuming Stop consuming data.
Method stopProducing Stop producing data.
Method stopReading Stop waiting for read availability.
Method stopWriting Stop waiting for write availability.
Method writeConnectionLost Indicates write connection was lost.
Constant SEND_LIMIT Undocumented
Class Variable bufferSize Undocumented
Class Variable disconnecting Undocumented
Instance Variable connected Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producerPaused Undocumented
Instance Variable reactor Undocumented
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.
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Class Variable _writeDisconnected Undocumented
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _writeDisconnecting Undocumented

Inherited from _ConsumerMixin (via ConnectionMixin, FileDescriptor):

Instance Variable streamingProducer bool or int

Inherited from _LogOwner (via ConnectionMixin, FileDescriptor, _ConsumerMixin):

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 (via ConnectionMixin, FileDescriptor, _ConsumerMixin, _LogOwner):

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

Inherited from _AbortingMixin (via ConnectionMixin, FileDescriptor, _ConsumerMixin, _LogOwner, _SocketCloser):

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called.
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
Parameters
sktUndocumented
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.
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IFileDescriptor
overrides twisted.internet.abstract.FileDescriptor.connectionLost

See abstract.FileDescriptor.connectionLost().

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 getHandle(self): (source)
from twisted.internet.interfaces.ISystemHandle

Return the socket for this connection.

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

Return if SO_KEEPALIVE is enabled.

def getTcpNoDelay(self): (source)
from twisted.internet.interfaces.ITCPTransport
overridden in twisted.internet.unix.Client, twisted.internet.unix.Server

Return if TCP_NODELAY is enabled.

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 readConnectionLost(self, reason): (source)
from twisted.internet.interfaces.IHalfCloseableDescriptor
overrides twisted.internet.abstract.FileDescriptor.readConnectionLost

Indicates read connection was lost.

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.

def setTcpNoDelay(self, enabled): (source)
from twisted.internet.interfaces.ITCPTransport
overridden in twisted.internet.unix.Client, twisted.internet.unix.Server

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

logstr: str = (source)
overridden in twisted.internet.tcp.BaseClient, twisted.internet.tcp.Server

prefix used when logging events related to this connection.

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

Undocumented

socket = (source)

Undocumented

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

Undocumented

def _dataReceived(self, data): (source)

Undocumented