class documentation

class FileHandle(_ConsumerMixin, _LogOwner): (source)

Known subclasses: twisted.internet.iocpreactor.tcp.Connection, twisted.internet.iocpreactor.udp.Port

Implements interfaces: twisted.internet.interfaces.IConsumer, twisted.internet.interfaces.IHalfCloseableDescriptor, twisted.internet.interfaces.IPushProducer, twisted.internet.interfaces.ITransport

View In Hierarchy

File handle that can read and write asynchronously

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
Method readFromHandle Undocumented
Method dataReceived Undocumented
Method readConnectionLost Indicates read connection was lost.
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
Method writeToHandle Undocumented
Method write Reliably write some data.
Method writeSequence Write an iterable of byte strings to the physical connection.
Instance Variable connected Undocumented
Instance Variable disconnected Undocumented
Instance Variable disconnecting Undocumented
Class Variable logstr Undocumented
Class Variable SEND_LIMIT Undocumented
Method __init__ Undocumented
Instance Variable reactor Undocumented
Method connectionLost The connection was lost.
Instance Variable producer Undocumented
Method getFileHandle Undocumented
Method loseConnection Close the connection at the next available opportunity.
Method stopConsuming Stop consuming data.
Method resumeProducing Resume producing data.
Method pauseProducing Pause producing data.
Method stopProducing Stop producing data.
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method getPeer Get the remote address of this connection.
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 _closeWriteConnection 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:

Instance Variable streamingProducer bool or int
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.

Inherited from _LogOwner:

Method logPrefix Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
Method _getLogPrefix Determine the log prefix to use for messages related to applicationObject, which may or may not be an interfaces.ILoggingContext provider.
maxReadBuffers = (source)

Undocumented

(type: int)
readBufferSize = (source)

Undocumented

(type: int)
reading = (source)

Undocumented

(type: bool)
dynamicReadBuffers = (source)

Undocumented

(type: bool)
_readNextBuffer = (source)

Undocumented

(type: int)
_readSize = (source)

Undocumented

_readScheduled = (source)

Undocumented

_readScheduledInOS = (source)

Undocumented

(type: bool)
def startReading(self): (source)

Undocumented

def stopReading(self): (source)

Undocumented

def _resumeReading(self): (source)

Undocumented

def _dispatchData(self): (source)

Dispatch previously read data. Return True if self.reading and we don't have any more data

def _cbRead(self, rc, data, evt): (source)

Undocumented

def _handleRead(self, rc, data, evt): (source)

Returns False if we should stop reading for now

def doRead(self): (source)

Undocumented

def readFromHandle(self, bufflist, evt): (source)

Undocumented

def dataReceived(self, data): (source)

Undocumented

def readConnectionLost(self, reason): (source)
dataBuffer = (source)

Undocumented

offset = (source)

Undocumented

(type: int)
writing = (source)

Undocumented

(type: bool)
_writeScheduled = (source)

Undocumented

_writeDisconnecting = (source)

Undocumented

(type: bool)
_writeDisconnected = (source)

Undocumented

(type: bool)
writeBufferSize = (source)

Undocumented

def loseWriteConnection(self): (source)

Undocumented

def _closeWriteConnection(self): (source)

Undocumented

def writeConnectionLost(self, reason): (source)

Indicates write connection was lost.

def startWriting(self): (source)

Override in a subclass to cause the reactor to monitor this selectable for write events. This will be called once in unregisterProducer if loseConnection has previously been called, so that the connection can actually close.

def stopWriting(self): (source)

Undocumented

def _resumeWriting(self): (source)

Undocumented

def _cbWrite(self, rc, numBytesWritten, evt): (source)

Undocumented

def _handleWrite(self, rc, numBytesWritten, evt): (source)

Returns false if we should stop writing for now

producerPaused = (source)
def doWrite(self): (source)

Undocumented

_tempDataBuffer = (source)

Undocumented

(type: list)
_tempDataLen = (source)

Undocumented

(type: int)
def writeToHandle(self, buff, evt): (source)

Undocumented

def write(self, data): (source)

Reliably write some data.

The data is buffered until his file descriptor is ready for writing.

def writeSequence(self, iovec): (source)

Write an iterable of byte strings to the physical connection.

If possible, make sure that all of the data is written to the socket at once, without first copying it all into a single byte string.

ParametersiovecUndocumented
dataThe data to write.
disconnected = (source)

Undocumented

(type: bool)
disconnecting = (source)

Undocumented

(type: int)
SEND_LIMIT = (source)

Undocumented

def __init__(self, reactor=None): (source)
reactor = (source)

Undocumented

_readBuffers = (source)

Undocumented

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 getFileHandle(self): (source)

Undocumented

def loseConnection(self, _connDone=failure.Failure(main.CONNECTION_DONE)): (source)

Close the connection at the next available opportunity.

Call this to cause this FileDescriptor to lose its connection. It will first write any data that it has buffered.

If there is data buffered yet to be written, this method will cause the transport to lose its connection as soon as it's done flushing its write buffer. If you have a producer registered, the connection won't be closed until the producer is finished. Therefore, make sure you unregister your producer when it's finished, or the connection will never close.

def stopConsuming(self): (source)

Stop consuming data.

This is called when a producer has lost its connection, to tell the consumer to go lose its connection (and break potential circular references).

def resumeProducing(self): (source)

Resume producing data.

This tells a producer to re-add itself to the main loop and produce more data for its consumer.

def pauseProducing(self): (source)

Pause producing data.

Tells a producer that it has produced too much data to process for the time being, and to stop until resumeProducing() is called.

def stopProducing(self): (source)

Stop producing data.

This tells a producer that its consumer has died, so it must stop producing data for good.

def getHost(self): (source)

Similar to getPeer, but returns an address describing this side of the connection.

ReturnsAn IAddress provider.
def getPeer(self): (source)

Get the remote address of this connection.

Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etc.

ReturnsAn IAddress provider.
API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.