twisted.internet.tcp.Connection(_TLSConnectionMixin, abstract.FileDescriptor, _SocketCloser, _AbortingMixin)class documentation
twisted.internet.tcpView 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 Variable||logstr||prefix used when logging events related to this connection. (type:
|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||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||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||resumeProducing||Resume producing data.|
|Method||pauseProducing||Pause producing 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||_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.|
|Instance Variable||producerPaused||A flag indicating whether the producer is currently paused. (type:
|Instance Variable||streamingProducer 0||A flag indicating whether the producer was registered as a streaming (ie
push) producer or not (ie a pull producer). This will determine whether
the consumer may ever need to pause and resume it, or if it can merely call
|Method||registerProducer||Register to receive data from a producer.|
|Method||unregisterProducer||Stop consuming data from a producer, without disconnecting.|
|Method||_getLogPrefix||Determine the log prefix to use for messages related to
Inherited from _SocketCloser:
|Instance Variable||_shouldShutdown||Set to
Inherited from _AbortingMixin:
|Method||abortConnection||Aborts the connection immediately, dropping any buffered data.|
|Instance Variable||_aborting||Set to
Return the socket for this connection.
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
self.SEND_LIMIT bytes from
data. If the connection is lost, an exception is returned.
Otherwise, the number of bytes successfully written is returned.
Indicates read connection was lost.
TCP_NODELAY is enabled.
TCP_NODELAY turns off Nagle's algorithm. Small
packets are sent sooner, possibly at the expense of overall throughput.
SO_KEEPALIVE is enabled.
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