class documentation

class twisted.internet.iocpreactor.tcp.Connection(abstract.FileHandle, _SocketCloser, _AbortingMixin): (source)

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

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

View In Hierarchy

Instance Variable TLS False to indicate the connection is in normal TCP mode, True to indicate that TLS has been started and that operations must be routed through the TLSMemoryBIOProtocol instance.
Method __init__ Undocumented
Instance Variable socket Undocumented
Instance Variable protocol Undocumented
Method getHandle Return a system- and reactor-specific handle.
Method dataReceived
Method readFromHandle Read into the given buffers from this handle.
Method writeToHandle Send buff to current file handle using _iocp.send. The buffer sent is limited to a size of self.SEND_LIMIT.
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 is enabled.
Method setTcpKeepAlive Enable/disable SO_KEEPALIVE.
Method startTLS
Method write Write some data, either directly to the underlying handle or, if TLS has been started, to the TLSMemoryBIOProtocol for it to encrypt and send.
Method writeSequence Write some data, either directly to the underlying handle or, if TLS has been started, to the TLSMemoryBIOProtocol for it to encrypt and send.
Method loseConnection Close the underlying handle or, if TLS has been started, first shut it down.
Method registerProducer Register a producer.
Method unregisterProducer Unregister a producer.
Method getHost Returns IPv4Address or IPv6Address.
Method getPeer Returns IPv4Address or IPv6Address.
Method _closeWriteConnection Undocumented

Inherited from FileHandle:

Class Variable maxReadBuffers Undocumented
Class Variable readBufferSize Undocumented
Instance Variable reading Undocumented
Class Variable dynamicReadBuffers Undocumented
Method startReading Undocumented
Method stopReading Undocumented
Method doRead Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable offset Undocumented
Instance Variable writing Undocumented
Class Variable writeBufferSize Undocumented
Method loseWriteConnection Undocumented
Method writeConnectionLost Indicates write connection was lost.
Method startWriting No summary
Method stopWriting Undocumented
Instance Variable producerPaused Undocumented
Method doWrite Undocumented
Instance Variable connected Undocumented
Instance Variable disconnected Undocumented
Instance Variable disconnecting Undocumented
Class Variable logstr Undocumented
Class Variable SEND_LIMIT Undocumented
Instance Variable reactor Undocumented
Instance Variable producer Undocumented
Method getFileHandle Undocumented
Method stopConsuming Stop consuming data.
Method resumeProducing Resume producing data.
Method pauseProducing Pause producing data.
Method stopProducing Stop producing data.
Instance Variable _readNextBuffer Undocumented
Instance Variable _readSize Undocumented
Instance Variable _readScheduled Undocumented
Instance Variable _readScheduledInOS Undocumented
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
Instance Variable _writeScheduled Undocumented
Instance Variable _writeDisconnecting Undocumented
Instance Variable _writeDisconnected Undocumented
Method _resumeWriting Undocumented
Method _cbWrite Undocumented
Method _handleWrite Returns false if we should stop writing for now
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _readBuffers Undocumented

Inherited from _ConsumerMixin (via FileHandle):

Instance Variable streamingProducer bool or int

Inherited from _LogOwner (via FileHandle):

Method _getLogPrefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.

Inherited from _SocketCloser:

Instance Variable _shouldShutdown Set to True if shutdown should be called before calling close on the underlying socket.
Method _closeSocket Undocumented

Inherited from _AbortingMixin:

Method abortConnection Aborts the connection immediately, dropping any buffered data.
Instance Variable doRead Undocumented
Instance Variable doWrite Undocumented
Instance Variable _aborting Set to True when abortConnection is called.
False to indicate the connection is in normal TCP mode, True to indicate that TLS has been started and that operations must be routed through the TLSMemoryBIOProtocol instance.
(type: bool)
socket = (source)

Undocumented

protocol = (source)

Undocumented

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)
ParametersrbufferData received. (type: bytes or bytearray)
def readFromHandle(self, bufflist, evt): (source)

Read into the given buffers from this handle.

Parametersbufflistthe buffers to read into (type: list of objects implementing the read/write buffer protocol)
evtan IOCP Event object
Returnstuple (return code, number of bytes read)
def writeToHandle(self, buff, evt): (source)

Send buff to current file handle using _iocp.send. The buffer sent is limited to a size of self.SEND_LIMIT.

def _closeWriteConnection(self): (source)
def readConnectionLost(self, reason): (source)
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 is 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.

def startTLS(self, contextFactory, normal=True): (source)
def write(self, data): (source)

Write some data, either directly to the underlying handle or, if TLS has been started, to the TLSMemoryBIOProtocol for it to encrypt and send.

See Alsotwisted.internet.interfaces.ITransport.write
def writeSequence(self, iovec): (source)

Write some data, either directly to the underlying handle or, if TLS has been started, to the TLSMemoryBIOProtocol for it to encrypt and send.

See Alsotwisted.internet.interfaces.ITransport.writeSequence
def loseConnection(self, reason=None): (source)
def registerProducer(self, producer, streaming): (source)

Register a producer.

If TLS is enabled, the TLS connection handles this.

def unregisterProducer(self): (source)

Unregister a producer.

If TLS is enabled, the TLS connection handles this.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.