interface documentation

class IReadDescriptor(IFileDescriptor): (source)

Known subclasses: twisted.internet.interfaces.IReadWriteDescriptor

View In Hierarchy

An IFileDescriptor that can read.

This interface is generally used in conjunction with IReactorFDSet.

Method doRead Some data is available for reading on your descriptor.

Inherited from IFileDescriptor:

Method fileno No summary
Method connectionLost Called when the connection was lost.

Inherited from ILoggingContext (via IFileDescriptor):

Method logPrefix
def doRead(): (source)

Some data is available for reading on your descriptor.

ReturnsIf an error is encountered which causes the descriptor to no longer be valid, a Failure should be returned. Otherwise, None. (type: Optional[Failure])
API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.