twisted.internet.interfaces.IReadDescriptor

interface documentation

class IReadDescriptor(IFileDescriptor): (source)

Known subclasses: twisted.internet.interfaces.IReadWriteDescriptor

Known implementations: twisted.internet._signals._FDWaker

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

Inherited from ILoggingContext (via IFileDescriptor):

Method logPrefix No summary
def doRead() -> Optional[Failure]: (source)

Some data is available for reading on your descriptor.

Returns
Optional[Failure]If an error is encountered which causes the descriptor to no longer be valid, a Failure should be returned. Otherwise, None.