twisted.internet.tcp.Connection : API documentation

t.i.t.Connection(abstract.FileDescriptor, _SocketCloser) : class documentation

Superclass of all socket-based FileDescriptors.

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

Instance Variables logstr prefix used when logging events related to this connection. (type: str )

Method	__init__	Undocumented
Method	startTLS	Initiate TLS negotiation.
Method	getHandle	Return the socket for this connection.
Method	doRead	Calls self.protocol.dataReceived with all available data.
Method	writeSomeData	No summary
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 enabled.
Method	setTcpKeepAlive	Enable/disable SO_KEEPALIVE.
Method	_startTLS	Undocumented
Method	_closeWriteConnection	Undocumented

Inherited from FileDescriptor:

Method	doWrite	Called when data can be written.
Method	writeConnectionLost	Indicates write connection was lost.
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.
Method	registerProducer	Register to receive data from a producer.
Method	unregisterProducer	Stop consuming data from a producer, without disconnecting.
Method	stopConsuming	Stop consuming data.
Method	resumeProducing	Undocumented
Method	pauseProducing	Undocumented
Method	stopProducing	Stop producing data.
Method	fileno	File Descriptor number for select().
Method	_postLoseConnection	Called after a loseConnection(), when all data has been written.

Inherited from Ephemeral (via FileDescriptor):

Method	__getstate__	Undocumented
Method	__setstate__	Undocumented

Inherited from _SocketCloser:

Method

_closeSocket

Undocumented

def _startTLS(self): (source)

Undocumented

def doRead(self): (source)

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 writeSomeData(self, data): (source)

overrides twisted.internet.abstract.FileDescriptor.writeSomeData

Connection.writeSomeData(data) -> #of bytes written | CONNECTION_LOST This writes as much data as possible to the socket and returns either the number of bytes read (which is positive) or a connection error code (which is negative)

def logPrefix(self): (source)

overrides twisted.python.log.Logger.logPrefix

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

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