Part of twisted.internet.abstract View Source View In Hierarchy
Known subclasses: twisted.internet.base.BasePort, twisted.internet.inotify.INotify, twisted.internet.process.ProcessReader, twisted.internet.process.ProcessWriter, twisted.internet.process.PTYProcess, twisted.internet.serialport.SerialPort, twisted.internet.serialport.SerialPort, twisted.internet.tcp.Connection, twisted.pair.tuntap.TuntapPort
This is an abstract superclass of all objects which may be notified when they are readable or writable; e.g. they have a file-descriptor that is valid to be passed to select(2).
| Method | __init__ | |
| Method | connectionLost | The connection was lost. |
| Method | writeSomeData | Write as much as possible of the given data, immediately. |
| Method | doRead | Called when data is available for reading. |
| Method | doWrite | Called when data can be written. |
| Method | writeConnectionLost | Undocumented |
| Method | readConnectionLost | Undocumented |
| 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 | loseWriteConnection | Undocumented |
| 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 | Undocumented |
| Method | pauseProducing | Undocumented |
| Method | stopProducing | Undocumented |
| Method | fileno | File Descriptor number for select(). |
| Method | _postLoseConnection | Called after a loseConnection(), when all data has been written. |
| 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. |
Inherited from _ConsumerMixin:
| Instance Variable | producer | None if no producer is registered, otherwise the registered
producer. |
| Instance Variable | producerPaused | A flag indicating whether the producer is currently paused. (type: bool) |
| 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
resumeProducing on it when buffer space is available. |
| 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. |
| Parameters | reactor | An 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. |
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.
This is called to invoke the lower-level writing functionality, such as a socket's send() method, or a file's write(); this method returns an integer or an exception. If an integer, it is the number of bytes written (possibly zero); if an exception, it indicates the connection was lost.
Subclasses must override this method. The result will be interpreted in the same way as a result of doWrite().
| Returns | None on success, an exception or a negative integer on
failure. | |
| See Also | twisted.internet.interfaces.IWriteDescriptor.doWrite. | |
Whatever this returns is then returned by doWrite.
When the buffer contains more than self.bufferSize bytes,
it is considered full. This might be improved by considering the size of
the kernel send buffer and how much of it is free.
| Returns | True if it is full, False otherwise. | |
The data is buffered until the underlying file descriptor is ready for
writing. If there is more than self.bufferSize data in the
buffer and this descriptor has a registered streaming producer, its
pauseProducing() method will be called.
Currently, this is a convenience method roughly equivalent to:
for chunk in iovec:
fd.write(chunk)
It may have a more efficient implementation at a later time or in a different reactor.
As with the write() method, if a buffer size limit is
reached and a streaming producer is registered, it will be paused until the
buffered data is written to the underlying file descriptor.
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.
Call this to remove this selectable from being notified when it is ready for reading.
Call this to remove this selectable from being notified when it is ready for writing.
Call this to have this FileDescriptor be notified whenever it is ready for writing.
This is called when a producer has lost its connection, to tell the consumer to go lose its connection (and break potential circular references).
This method must be overridden or assigned in subclasses to indicate a valid file descriptor for the operating system.