twisted.internet.tcp.Connection(_TLSConnectionMixin, abstract.FileDescriptor, _SocketCloser, _AbortingMixin) class documentation

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

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

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

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. (type: str)
Method __init__
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 _AbortingMixin:

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called. (type: bool)

Inherited from _AbortingMixin:

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called. (type: bool)

Inherited from _AbortingMixin:

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called. (type: bool)

Inherited from _AbortingMixin:

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called. (type: bool)

Inherited from _AbortingMixin:

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable _aborting Set to True when abortConnection is called. (type: bool)
logstr =
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
ParametersreactorAn 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 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 at 2016-05-18 16:01:36.