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

Part of twisted.internet.iocpreactor.tcp View Source View In Hierarchy

Known subclasses: twisted.internet.iocpreactor.tcp.Client, twisted.internet.iocpreactor.tcp.Server

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

No class docstring
Method __init__ Undocumented
Method getHandle Return a system- and reactor-specific handle.
Method dataReceived Undocumented
Method readFromHandle Undocumented
Method writeToHandle Undocumented
Method readConnectionLost Indicates read connection was lost.
Method connectionLost The connection was lost.
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 _closeWriteConnection Undocumented

Inherited from FileHandle:

Method startReading Undocumented
Method stopReading Undocumented
Method doRead Undocumented
Method loseWriteConnection Undocumented
Method writeConnectionLost Indicates write connection was lost.
Method startWriting Undocumented
Method stopWriting Undocumented
Method doWrite Undocumented
Method write Reliably write some data.
Method writeSequence Write a list of strings to the physical connection.
Method getFileHandle Undocumented
Method loseConnection Close the connection at the next available opportunity.
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 _resumeReading Undocumented
Method _dispatchData Dispatch previously read data. Return True if self.reading and we don't have any more data
Method _cbRead Undocumented
Method _handleRead Returns False if we should stop reading for now
Method _resumeWriting Undocumented
Method _cbWrite Undocumented
Method _handleWrite Returns false if we should stop writing for now

Inherited from Ephemeral (via FileHandle):

Method __getstate__ Undocumented
Method __setstate__ Undocumented

Inherited from _SocketCloser:

Method _closeSocket Undocumented
def __init__(self, sock, proto, reactor=None): (source)
def getHandle(self): (source)

Return a system- and reactor-specific handle.

This might be a socket.socket() object, or some other type of object, depending on which reactor is being used. Use and manipulate at your own risk.

This might be used in cases where you want to set specific options not exposed by the Twisted APIs.
def dataReceived(self, rbuffer): (source)
def readFromHandle(self, bufflist, evt): (source)
def writeToHandle(self, buff, evt): (source)
def _closeWriteConnection(self): (source)
def readConnectionLost(self, reason): (source)
Indicates read connection was lost.
def connectionLost(self, reason): (source)

The connection was lost.

This is called when the connection on a selectable object has been lost. It will be called whether the connection was closed explicitly, an exception occurred in an event handler, or the other end of the connection closed it first.

Clean up state here, but make sure to call back up to FileDescriptor.
def logPrefix(self): (source)
Return the prefix to log with when I own the logging thread.
def getTcpNoDelay(self): (source)
Return if TCP_NODELAY is enabled.
def setTcpNoDelay(self, enabled): (source)

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)
Return if SO_KEEPALIVE enabled.
def setTcpKeepAlive(self, enabled): (source)

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 2011-10-27 15:57:47.