Part of twisted.internet.tcp View Source 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 Variables||logstr||prefix used when logging events related to this connection.
|Method||startTLS||Initiate TLS negotiation.|
|Method||write||Reliably write some data.|
|Method||writeSequence||Reliably write a sequence of data.|
|Method||doWrite||Called when data can be written.|
|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||logPrefix||Return the prefix to log with when I own the logging thread.|
Inherited from FileDescriptor:
|Method||writeConnectionLost||Indicates write connection was lost.|
|Method||loseConnection||Close the connection at the next available opportunity.|
|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||stopConsuming||Stop consuming data.|
|Method||stopProducing||Stop producing data.|
|Method||fileno||File Descriptor number for select().|
|Method||_postLoseConnection||Called after a loseConnection(), when all data has been written.|
|Method||registerProducer||Register to receive data from a producer.|
|Method||unregisterProducer||Stop consuming data from a producer, without disconnecting.|
Inherited from _SocketCloser:
Reliably write some data.The data is buffered until the underlying file descriptor is ready for writing. If there is more than
self.bufferSizedata in the buffer and this descriptor has a registered streaming producer, its
pauseProducing()method will be called.
Reliably write a sequence of data.Currently, this is a convenience method roughly equivalent to:
for chunk in iovec: fd.write(chunk)
It may have a more efficient implementation at a later time or in a different reactor.As with the
write()method, if a buffer size limit is reached and a streaming producer is registered, it will be paused until the buffered data is written to the underlying file descriptor.
Called when data can be written.A result that is true (which will be a negative number or an exception instance) indicates that the connection was lost. A false result implies the connection is still there; a result of 0 indicates no write was done, and a result of None indicates that a write was done.
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.
Write as much as possible of the given data to this TCP connection.This sends up to
data. If the connection is lost, an exception is returned. Otherwise, the number of bytes successfully written is returned.
TCP_NODELAYturns off Nagle's algorithm. Small packets are sent sooner, possibly at the expense of overall throughput.
SO_KEEPALIVEsends 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.