twisted.internet.interfaces.IReactorFDSet

interface documentation

class IReactorFDSet(Interface): (source)

View In Hierarchy

Implement me to be able to use IFileDescriptor type resources.

This assumes that your main-loop uses UNIX-style numeric file descriptors (or at least similarly opaque IDs returned from a .fileno() method)

Method addReader I add reader to the set of file descriptors to get read events for.
Method addWriter I add writer to the set of file descriptors to get write events for.
Method getReaders Return the list of file descriptors currently monitored for input events by the reactor.
Method getWriters Return the list file descriptors currently monitored for output events by the reactor.
Method removeAll Remove all readers and writers.
Method removeReader Removes an object previously added with addReader.
Method removeWriter Removes an object previously added with addWriter.
def addReader(reader): (source)

I add reader to the set of file descriptors to get read events for.

Parameters
reader:IReadDescriptorAn IReadDescriptor provider that will be checked for read events until it is removed from the reactor with removeReader.
def addWriter(writer): (source)

I add writer to the set of file descriptors to get write events for.

Parameters
writer:IWriteDescriptorAn IWriteDescriptor provider that will be checked for write events until it is removed from the reactor with removeWriter.
def getReaders(): (source)

Return the list of file descriptors currently monitored for input events by the reactor.

Returns
List[IReadDescriptor]the list of file descriptors monitored for input events.
def getWriters(): (source)

Return the list file descriptors currently monitored for output events by the reactor.

Returns
List[IWriteDescriptor]the list of file descriptors monitored for output events.
def removeAll(): (source)

Remove all readers and writers.

Should not remove reactor internal reactor connections (like a waker).

Returns
List[Union[IReadDescriptor, IWriteDescriptor]]A list of IReadDescriptor and IWriteDescriptor providers which were removed.
def removeReader(reader): (source)

Removes an object previously added with addReader.

Parameters
reader:IReadDescriptorUndocumented
def removeWriter(writer): (source)

Removes an object previously added with addWriter.

Parameters
writer:IWriteDescriptorUndocumented