twisted.internet.epollreactor.EPollReactor(posixbase.PosixReactorBase, posixbase._PollLikeMixin) class documentation

Part of twisted.internet.epollreactor View Source (View In Hierarchy)

Implements interfaces: twisted.internet.interfaces.IReactorFDSet

A reactor that uses epoll(7).

Method __init__ Initialize epoll object, file descriptor tracking dictionaries, and the base class.
Method addReader Add a FileDescriptor for notification of data available to read.
Method addWriter Add a FileDescriptor for notification of data available to write.
Method removeReader Remove a Selectable for notification of data available to read.
Method removeWriter Remove a Selectable for notification of data available to write.
Method removeAll Remove all selectables, and return a list of them.
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 doPoll Poll the poller for new events.
Instance Variable _poller A epoll which will be used to check for I/O readiness.
Instance Variable _selectables A dictionary mapping integer file descriptors to instances of FileDescriptor which have been registered with the reactor. All FileDescriptors which are currently receiving read or write readiness notifications will be present as values in this dictionary.
Instance Variable _reads A set containing integer file descriptors. Values in this set will be registered with _poller for read readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
Instance Variable _writes A set containing integer file descriptors. Values in this set will be registered with _poller for write readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
Instance Variable _continuousPolling A _ContinuousPolling instance, used to handle file descriptors (e.g. filesystem files) that are not supported by epoll(7).
Method _add Private method for adding a descriptor from the event loop.
Method _remove Private method for removing a descriptor from the event loop.

Inherited from PosixReactorBase:

Method installWaker Install a `waker' to allow threads and signals to wake up the IO thread.
Method spawnProcess Spawn a process, with a process protocol.
Method listenUDP Connects a given DatagramProtocol to the given numeric UDP port.
Method listenMulticast Connects a given DatagramProtocol to the given numeric UDP port.
Method connectUNIX Connect a client protocol to a UNIX socket.
Method listenUNIX Listen on a UNIX socket.
Method listenUNIXDatagram Connects a given DatagramProtocol to the given path.
Method connectUNIXDatagram Connects a ConnectedDatagramProtocol instance to a path.
Method adoptStreamPort Create a new IListeningPort from an already-initialized socket.
Method adoptStreamConnection
Method adoptDatagramPort Add an existing listening SOCK_DGRAM socket to the reactor to monitor for read and write readiness.
Method listenTCP Connects a given protocol factory to the given numeric TCP/IP port.
Method connectTCP Connect a TCP client.
Method connectSSL Connect a client Protocol to a remote SSL socket.
Method listenSSL Connects a given protocol factory to the given numeric TCP/IP port. The connection is a SSL one, using contexts created by the context factory.
Instance Variable _childWaker None or a reference to the _SIGCHLDWaker which is used to properly notice child process termination.
Method _handleSignals Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
Method _uninstallHandler If a child waker was created and installed, uninstall it now.
Method _removeAll Remove all readers and writers, and list of removed IReadDescriptors and IWriteDescriptors.

Inherited from _SignalReactorMixin (via PosixReactorBase):

Method startRunning Extend the base implementation in order to remember whether signal handlers should be installed later.
Method run Undocumented
Method mainLoop Undocumented
Instance Variable _installSignalHandlers A flag which indicates whether any signal handlers will be installed during startup. This includes handlers for SIGCHLD to monitor child processes, and SIGINT, SIGTERM, and SIGBREAK to stop the reactor. (type: bool)
Method _reallyStartRunning Extend the base implementation by also installing signal handlers, if self._installSignalHandlers is true.

Inherited from _DisconnectSelectableMixin (via PosixReactorBase):

Method _disconnectSelectable Utility function for disconnecting a selectable.

Inherited from ReactorBase (via PosixReactorBase):

Instance Variable running See IReactorCore.running
Method installResolver See IReactorPluggableResolver.
Method installNameResolver See IReactorPluggableNameResolver.
Method nameResolver Implementation of read-only IReactorPluggableNameResolver.nameResolver.
Method wakeUp Wake up the event loop.
Method doIteration Do one iteration over the readers and writers which have been added.
Method resolve Return a Deferred that will resolve a hostname.
Method stop See twisted.internet.interfaces.IReactorCore.stop.
Method crash See twisted.internet.interfaces.IReactorCore.crash.
Method sigInt Handle a SIGINT interrupt.
Method sigBreak Handle a SIGBREAK interrupt.
Method sigTerm Handle a SIGTERM interrupt.
Method disconnectAll Disconnect every reader, and writer in the system.
Method iterate See twisted.internet.interfaces.IReactorCore.iterate.
Method fireSystemEvent See twisted.internet.interfaces.IReactorCore.fireSystemEvent.
Method addSystemEventTrigger See twisted.internet.interfaces.IReactorCore.addSystemEventTrigger.
Method removeSystemEventTrigger See twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger.
Method callWhenRunning See twisted.internet.interfaces.IReactorCore.callWhenRunning.
Method startRunning Method called when reactor starts: do some initialization and fire startup events.
Method callLater See twisted.internet.interfaces.IReactorTime.callLater.
Method getDelayedCalls No summary
Method timeout Determine the longest time the reactor may sleep (waiting on I/O notification, perhaps) before it must wake up to service a time-related event.
Method runUntilCurrent Run all pending timed calls.
Method callFromThread 0 See twisted.internet.interfaces.IReactorFromThreads.callFromThread.
Method getThreadPool See twisted.internet.interfaces.IReactorThreads.getThreadPool.
Method callInThread See twisted.internet.interfaces.IReactorInThreads.callInThread.
Method suggestThreadPoolSize See twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize.
Method callFromThread Cause a function to be executed by the reactor thread.
Instance Variable _stopped A flag which is true between paired calls to reactor.run and reactor.stop. This should be replaced with an explicit state machine. (type: bool)
Instance Variable _justStopped A flag which is true between the time reactor.stop is called and the time the shutdown system event is fired. This is used to determine whether that event should be fired after each iteration through the mainloop. This should be replaced with an explicit state machine. (type: bool)
Instance Variable _started A flag which is true from the time reactor.run is called until the time reactor.run returns. This is used to prevent calls to reactor.run on a running reactor. This should be replaced with an explicit state machine. (type: bool)
Instance Variable _registerAsIOThread A flag controlling whether the reactor will register the thread it is running in as the I/O thread when it starts. If True, registration will be done, otherwise it will not be.
Instance Variable _exitSignal See _ISupportsExitSignalCapturing._exitSignal
Method _reallyStartRunning Method called to transition to the running state. This should happen in the during startup event trigger phase.
Method _moveCallLaterSooner Undocumented
Method _cancelCallLater Undocumented
Method _insertNewDelayedCalls Undocumented
Method _checkProcessArgs Check for valid arguments and environment to spawnProcess.
Method _initThreads Undocumented
Method _initThreadPool Create the threadpool accessible with callFromThread.
Method _stopThreadPool No summary

Inherited from _PollLikeMixin:

Method _doReadOrWrite fd is available for read or write, do the work and raise errors if necessary.
_poller =
A epoll which will be used to check for I/O readiness.
_selectables =
A dictionary mapping integer file descriptors to instances of FileDescriptor which have been registered with the reactor. All FileDescriptors which are currently receiving read or write readiness notifications will be present as values in this dictionary.
_reads =
A set containing integer file descriptors. Values in this set will be registered with _poller for read readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
_writes =
A set containing integer file descriptors. Values in this set will be registered with _poller for write readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
_continuousPolling =
A _ContinuousPolling instance, used to handle file descriptors (e.g. filesystem files) that are not supported by epoll(7).
def __init__(self): (source)
overrides twisted.internet.base.ReactorBase.__init__

Initialize epoll object, file descriptor tracking dictionaries, and the base class.

def _add(self, xer, primary, other, selectables, event, antievent): (source)

Private method for adding a descriptor from the event loop.

It takes care of adding it if new or modifying it if already added for another state (read -> read/write for example).

def addReader(self, reader): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.addReader

Add a FileDescriptor for notification of data available to read.

def addWriter(self, writer): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.addWriter

Add a FileDescriptor for notification of data available to write.

def _remove(self, xer, primary, other, selectables, event, antievent): (source)

Private method for removing a descriptor from the event loop.

It does the inverse job of _add, and also add a check in case of the fd has gone away.

def removeReader(self, reader): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.removeReader

Remove a Selectable for notification of data available to read.

def removeWriter(self, writer): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.removeWriter

Remove a Selectable for notification of data available to write.

def removeAll(self): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.removeAll

Remove all selectables, and return a list of them.

def getReaders(self): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.getReaders

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

Returnsthe list of file descriptors monitored for input events. (type: list of IReadDescriptor)
def getWriters(self): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.getWriters

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

Returnsthe list of file descriptors monitored for output events. (type: list of IWriteDescriptor)
def doPoll(self, timeout): (source)

Poll the poller for new events.

API Documentation for Twisted, generated by pydoctor at 2018-07-14 04:53:34.