twisted.internet.test.test_filedescriptor.MemoryFile

class documentation

class MemoryFile(FileDescriptor): (source)

View In Hierarchy

A FileDescriptor customization which writes to a Python list in memory with certain limitations.

Method __init__ No summary
Method startWriting Start waiting for write availability.
Method stopWriting Stop waiting for write availability.
Method writeSomeData Copy at most self._freeSpace bytes from data into self._written.
Class Variable connected Undocumented
Instance Variable _freeSpace A int giving the number of bytes which will be accepted by future writes.
Instance Variable _written A list of bytes which have been accepted as written.

Inherited from FileDescriptor:

Method connectionLost The connection was lost.
Method doRead Called when data is available for reading.
Method doWrite Called when data can be written.
Method fileno File Descriptor number for select().
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method getPeer Get the remote address of this connection.
Method loseConnection Close the connection at the next available opportunity.
Method loseWriteConnection Undocumented
Method pauseProducing Pause producing data.
Method readConnectionLost Indicates read connection was lost.
Method resumeProducing Resume producing data.
Method startReading Start waiting for read availability.
Method stopConsuming Stop consuming data.
Method stopProducing Stop producing data.
Method stopReading Stop waiting for read availability.
Method write Reliably write some data.
Method writeConnectionLost Indicates write connection was lost.
Method writeSequence Reliably write a sequence of data.
Constant SEND_LIMIT Undocumented
Class Variable bufferSize Undocumented
Class Variable disconnecting Undocumented
Instance Variable dataBuffer Undocumented
Instance Variable disconnected Undocumented
Instance Variable offset Undocumented
Instance Variable producer Undocumented
Instance Variable producerPaused Undocumented
Instance Variable reactor Undocumented
Method _closeWriteConnection Undocumented
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.
Method _postLoseConnection Called after a loseConnection(), when all data has been written.
Class Variable _writeDisconnected Undocumented
Instance Variable _tempDataBuffer Undocumented
Instance Variable _tempDataLen Undocumented
Instance Variable _writeDisconnecting Undocumented

Inherited from _ConsumerMixin (via FileDescriptor):

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

Inherited from _LogOwner (via FileDescriptor, _ConsumerMixin):

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.
def __init__(self): (source)
overrides twisted.internet.abstract.FileDescriptor.__init__
Parameters
reactorAn IReactorFDSet provider which this descriptor will use to get readable and writeable event notifications. If no value is given, the global reactor will be used.
def startWriting(self): (source)
overrides twisted.internet.abstract.FileDescriptor.startWriting

Start waiting for write availability.

Call this to have this FileDescriptor be notified whenever it is ready for writing.

def stopWriting(self): (source)
overrides twisted.internet.abstract.FileDescriptor.stopWriting

Stop waiting for write availability.

Call this to remove this selectable from being notified when it is ready for writing.

def writeSomeData(self, data): (source)
overrides twisted.internet.abstract.FileDescriptor.writeSomeData

Copy at most self._freeSpace bytes from data into self._written.

Returns
A int indicating how many bytes were copied from data.
connected: bool = (source)
overrides twisted.internet.abstract.FileDescriptor.connected

Undocumented

_freeSpace: int = (source)

A int giving the number of bytes which will be accepted by future writes.

_written: list = (source)

A list of bytes which have been accepted as written.