twisted.internet.interfaces.IReadDescriptor(IFileDescriptor) interface documentation

Part of twisted.internet.interfaces (View In Hierarchy)

Known subclasses: twisted.internet.interfaces.IReadWriteDescriptor

Known implementations: twisted.internet.test.test_fdset.RemovingDescriptor

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
Method connectionLost Called when the connection was lost.

Inherited from ILoggingContext (via IFileDescriptor):

Method logPrefix
def doRead():

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.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.