twisted.internet.epollreactor.EPollReactor

class documentation

class EPollReactor(posixbase.PosixReactorBase, posixbase._PollLikeMixin): (source)

Implements interfaces: twisted.internet.interfaces.IReactorFDSet

View In Hierarchy

A reactor that uses epoll(7).
Method __init__ Initialize epoll object, file descriptor tracking dictionaries, and the base class.
Method add​Reader Add a FileDescriptor for notification of data available to read.
Method add​Writer Add a FileDescriptor for notification of data available to write.
Method do​Poll Poll the poller for new events.
Method get​Readers Return the list of file descriptors currently monitored for input events by the reactor.
Method get​Writers Return the list file descriptors currently monitored for output events by the reactor.
Method remove​All Remove all selectables, and return a list of them.
Method remove​Reader Remove a Selectable for notification of data available to read.
Method remove​Writer Remove a Selectable for notification of data available to write.
Method _add Private method for adding a descriptor from the event loop.
Method _remove Private method for removing a descriptor from the event loop.
Constant _POLL​_DISCONNECTED Undocumented
Instance Variable _continuous​Polling A _ContinuousPolling instance, used to handle file descriptors (e.g. filesystem files) that are not supported by epoll(7).
Instance Variable _poller A epoll which will be used to check for I/O readiness.
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 _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 _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.

Inherited from PosixReactorBase:

Method adopt​Datagram​Port Add an existing listening SOCK_DGRAM socket to the reactor to monitor for read and write readiness.
Method adopt​Stream​Connection
Method adopt​Stream​Port Create a new IListeningPort from an already-initialized socket.
Method connect​SSL Connect a client Protocol to a remote SSL socket.
Method connect​TCP Connect a TCP client.
Method connect​UNIX Connect a client protocol to a UNIX socket.
Method connect​UNIXDatagram Connects a ConnectedDatagramProtocol instance to a path.
Method install​Waker Install a `waker' to allow threads and signals to wake up the IO thread.
Method listen​Multicast Connects a given DatagramProtocol to the given numeric UDP port.
Method listen​SSL 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.
Method listen​TCP Connects a given protocol factory to the given numeric TCP/IP port.
Method listen​UDP Connects a given DatagramProtocol to the given numeric UDP port.
Method listen​UNIX Listen on a UNIX socket.
Method listen​UNIXDatagram Connects a given DatagramProtocol to the given path.
Method spawn​Process Spawn a process, with a process protocol.
Instance Variable waker Undocumented
Method _handle​Signals Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
Method _remove​All Remove all readers and writers, and list of removed IReadDescriptors and IWriteDescriptors.
Method _uninstall​Handler If a child waker was created and installed, uninstall it now.
Class Variable _supported​Address​Families Undocumented
Instance Variable _child​Waker None or a reference to the _SIGCHLDWaker which is used to properly notice child process termination.

Inherited from _SignalReactorMixin (via PosixReactorBase):

Method main​Loop Undocumented
Method run Undocumented
Method start​Running Extend the base implementation in order to remember whether signal handlers should be installed later.
Method _really​Start​Running Extend the base implementation by also installing signal handlers, if self._installSignalHandlers is true.
Instance Variable _install​Signal​Handlers 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.

Inherited from _DisconnectSelectableMixin (via PosixReactorBase):

Method _disconnect​Selectable Utility function for disconnecting a selectable.

Inherited from ReactorBase (via PosixReactorBase):

Method add​System​Event​Trigger See twisted.internet.interfaces.IReactorCore.addSystemEventTrigger.
Method call​From​Thread See twisted.internet.interfaces.IReactorFromThreads.callFromThread.
Method call​In​Thread See twisted.internet.interfaces.IReactorInThreads.callInThread.
Method call​Later See twisted.internet.interfaces.IReactorTime.callLater.
Method call​When​Running See twisted.internet.interfaces.IReactorCore.callWhenRunning.
Method crash See twisted.internet.interfaces.IReactorCore.crash.
Method disconnect​All Disconnect every reader, and writer in the system.
Method do​Iteration Do one iteration over the readers and writers which have been added.
Method fire​System​Event See twisted.internet.interfaces.IReactorCore.fireSystemEvent.
Method get​Delayed​Calls No summary
Method get​Thread​Pool See twisted.internet.interfaces.IReactorThreads.getThreadPool.
Method iterate See twisted.internet.interfaces.IReactorCore.iterate.
Method remove​System​Event​Trigger See twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger.
Method resolve Return a Deferred that will resolve a hostname.
Method run Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with stop() or crash().
Method run​Until​Current Run all pending timed calls.
Method sig​Break Handle a SIGBREAK interrupt.
Method sig​Int Handle a SIGINT interrupt.
Method sig​Term Handle a SIGTERM interrupt.
Method start​Running Method called when reactor starts: do some initialization and fire startup events.
Method stop See twisted.internet.interfaces.IReactorCore.stop.
Method suggest​Thread​Pool​Size See twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize.
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 wake​Up Wake up the event loop.
Class Variable __name__ Undocumented
Class Variable installed Undocumented
Class Variable seconds Get the current time in seconds.
Instance Variable running See IReactorCore.running
Instance Variable thread​Call​Queue Undocumented
Instance Variable threadpool Undocumented
Instance Variable threadpool​Shutdown​ID Undocumented
Instance Variable using​Threads Undocumented
Method _cancel​Call​Later Undocumented
Method _check​Process​Args Check for valid arguments and environment to spawnProcess.
Method _init​Thread​Pool Create the threadpool accessible with callFromThread.
Method _init​Threads Undocumented
Method _insert​New​Delayed​Calls Undocumented
Method _move​Call​Later​Sooner Undocumented
Method _really​Start​Running Method called to transition to the running state. This should happen in the during startup event trigger phase.
Method _stop​Thread​Pool No summary
Class Variable _lock Undocumented
Instance Variable _cancellations Undocumented
Instance Variable _event​Triggers Undocumented
Instance Variable _exit​Signal See _ISupportsExitSignalCapturing._exitSignal
Instance Variable _internal​Readers Undocumented
Instance Variable _just​Stopped 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.
Instance Variable _new​Timed​Calls Undocumented
Instance Variable _pending​Timed​Calls Undocumented
Instance Variable _register​As​IOThread 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 _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.
Instance Variable _started​Before Undocumented
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.
Instance Variable _threadpool​Startup​ID Undocumented

Inherited from PluggableResolverMixin (via PosixReactorBase, ReactorBase):

Method install​Name​Resolver See IReactorPluggableNameResolver.
Method install​Resolver See IReactorPluggableResolver.
Instance Variable resolver The installed IResolverSimple.
Property name​Resolver Implementation of read-only IReactorPluggableNameResolver.nameResolver.
Instance Variable _name​Resolver The installed IHostnameResolver.

Inherited from _PollLikeMixin:

Method _do​Read​Or​Write fd is available for read or write, do the work and raise errors if necessary.
def __init__(self): (source)
overrides twisted.internet.base.ReactorBase.__init__
Initialize epoll object, file descriptor tracking dictionaries, and the base class.
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 doPoll(self, timeout): (source)
Poll the poller for new events.
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.
Returns
the list of file descriptors monitored for input events.
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.
Returns
the list of file descriptors monitored for output events.
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 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 _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 _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.

_POLL_DISCONNECTED = (source)

Undocumented

Value
EPOLLHUP|EPOLLERR
_continuousPolling = (source)
A _ContinuousPolling instance, used to handle file descriptors (e.g. filesystem files) that are not supported by epoll(7).
_poller = (source)
A epoll which will be used to check for I/O readiness.
_reads = (source)
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.
_selectables: dict = (source)
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.
_writes = (source)
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.