twisted.internet.base.ReactorBase(object) class documentation

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

Known subclasses: twisted.internet.iocpreactor.reactor.IOCPReactor, twisted.internet.posixbase.PosixReactorBase

Implements interfaces: twisted.internet.interfaces._ISupportsExitSignalCapturing, twisted.internet.interfaces.IReactorCore, twisted.internet.interfaces.IReactorPluggableNameResolver, twisted.internet.interfaces.IReactorPluggableResolver, twisted.internet.interfaces.IReactorThreads, twisted.internet.interfaces.IReactorTime

Default base class for Reactors.

Instance Variable running See IReactorCore.running
Method __init__ Undocumented
Method installWaker Undocumented
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 addReader Undocumented
Method addWriter Undocumented
Method removeReader Undocumented
Method removeWriter Undocumented
Method removeAll Undocumented
Method getReaders Undocumented
Method getWriters Undocumented
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 _uninstallHandler Undocumented
Method _stopThreadPool No summary
_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)
_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)
_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)
running =
See IReactorCore.running
_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.
_exitSignal =
See _ISupportsExitSignalCapturing._exitSignal
def __init__(self): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.iocpreactor.reactor.IOCPReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def installWaker(self): (source)
overridden in twisted.internet.iocpreactor.reactor.IOCPReactor, twisted.internet.posixbase.PosixReactorBase
Undocumented
def installResolver(self, resolver): (source)
from twisted.internet.interfaces.IReactorPluggableResolver

See IReactorPluggableResolver.

Parametersresolversee IReactorPluggableResolver.
Returnssee IReactorPluggableResolver.
def installNameResolver(self, resolver): (source)
from twisted.internet.interfaces.IReactorPluggableNameResolver

See IReactorPluggableNameResolver.

ParametersresolverSee IReactorPluggableNameResolver.
Returnssee IReactorPluggableNameResolver.
@property
def nameResolver(self): (source)
from twisted.internet.interfaces.IReactorPluggableNameResolver

Implementation of read-only IReactorPluggableNameResolver.nameResolver.

def wakeUp(self): (source)
overridden in twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.iocpreactor.reactor.IOCPReactor

Wake up the event loop.

def doIteration(self, delay): (source)
overridden in twisted.internet.iocpreactor.reactor.IOCPReactor

Do one iteration over the readers and writers which have been added.

def addReader(self, reader): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def addWriter(self, writer): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def removeReader(self, reader): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def removeWriter(self, writer): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def removeAll(self): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.iocpreactor.reactor.IOCPReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def getReaders(self): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def getWriters(self): (source)
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor, twisted.internet.epollreactor.EPollReactor, twisted.internet.kqreactor.KQueueReactor, twisted.internet.pollreactor.PollReactor, twisted.internet.selectreactor.SelectReactor, twisted.internet.win32eventreactor.Win32Reactor
Undocumented
def resolve(self, name, timeout=(1, 3, 11, 45)): (source)
from twisted.internet.interfaces.IReactorCore

Return a Deferred that will resolve a hostname.

def stop(self): (source)
from twisted.internet.interfaces.IReactorCore
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor

See twisted.internet.interfaces.IReactorCore.stop.

def crash(self): (source)
from twisted.internet.interfaces.IReactorCore
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._glibbase.PortableGlibReactorBase, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor

See twisted.internet.interfaces.IReactorCore.crash.

Reset reactor state tracking attributes and re-initialize certain state-transition helpers which were set up in __init__ but later destroyed (through use).

def sigInt(self, *args): (source)

Handle a SIGINT interrupt.

ParametersargsSee handler specification in signal.signal
def sigBreak(self, *args): (source)

Handle a SIGBREAK interrupt.

ParametersargsSee handler specification in signal.signal
def sigTerm(self, *args): (source)

Handle a SIGTERM interrupt.

ParametersargsSee handler specification in signal.signal
def disconnectAll(self): (source)

Disconnect every reader, and writer in the system.

def iterate(self, delay=0): (source)
from twisted.internet.interfaces.IReactorCore
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor

See twisted.internet.interfaces.IReactorCore.iterate.

def fireSystemEvent(self, eventType): (source)
from twisted.internet.interfaces.IReactorCore

See twisted.internet.interfaces.IReactorCore.fireSystemEvent.

def addSystemEventTrigger(self, _phase, _eventType, _f, *args, **kw): (source)
from twisted.internet.interfaces.IReactorCore

See twisted.internet.interfaces.IReactorCore.addSystemEventTrigger.

def removeSystemEventTrigger(self, triggerID): (source)
from twisted.internet.interfaces.IReactorCore

See twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger.

def callWhenRunning(self, _callable, *args, **kw): (source)
from twisted.internet.interfaces.IReactorCore

See twisted.internet.interfaces.IReactorCore.callWhenRunning.

def startRunning(self): (source)

Method called when reactor starts: do some initialization and fire startup events.

Don't call this directly, call reactor.run() instead: it should take care of calling this.

This method is somewhat misnamed. The reactor will not necessarily be in the running state by the time this method returns. The only guarantee is that it will be on its way to the running state.

def _reallyStartRunning(self): (source)

Method called to transition to the running state. This should happen in the during startup event trigger phase.

def callLater(self, _seconds, _f, *args, **kw): (source)
from twisted.internet.interfaces.IReactorTime
overridden in twisted.internet._glibbase.GlibReactorBase, twisted.internet._threadedselect.ThreadedSelectReactor, twisted.internet.asyncioreactor.AsyncioSelectorReactor, twisted.internet.cfreactor.CFReactor

See twisted.internet.interfaces.IReactorTime.callLater.

def _moveCallLaterSooner(self, tple): (source)
overridden in twisted.internet.cfreactor.CFReactor
Undocumented
def _cancelCallLater(self, tple): (source)
Undocumented
def getDelayedCalls(self): (source)
from twisted.internet.interfaces.IReactorTime
overridden in twisted.internet.asyncioreactor.AsyncioSelectorReactor

Return all the outstanding delayed calls in the system. They are returned in no particular order. This method is not efficient -- it is really only meant for test cases.

ReturnsA list of outstanding delayed calls.
def _insertNewDelayedCalls(self): (source)
Undocumented
def timeout(self): (source)

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.

ReturnsThe maximum number of seconds the reactor may sleep. (type: float)
def runUntilCurrent(self): (source)

Run all pending timed calls.

def _checkProcessArgs(self, args, env): (source)

Check for valid arguments and environment to spawnProcess.

ReturnsA two element tuple giving values to use when creating the process. The first element of the tuple is a list of bytes giving the values for argv of the child process. The second element of the tuple is either None if env was None or a dict mapping bytes environment keys to bytes environment values.
def _initThreads(self): (source)
Undocumented
def callFromThread 0(self, f, *args, **kw): (source)

See twisted.internet.interfaces.IReactorFromThreads.callFromThread.

def _initThreadPool(self): (source)

Create the threadpool accessible with callFromThread.

def _uninstallHandler(self): (source)
overridden in twisted.internet.posixbase.PosixReactorBase
Undocumented
def _stopThreadPool(self): (source)

Stop the reactor threadpool. This method is only valid if there is currently a threadpool (created by _initThreadPool). It is not intended to be called directly; instead, it will be called by a shutdown trigger created in _initThreadPool.

def getThreadPool(self): (source)
from twisted.internet.interfaces.IReactorThreads

See twisted.internet.interfaces.IReactorThreads.getThreadPool.

def callInThread(self, _callable, *args, **kwargs): (source)
from twisted.internet.interfaces.IReactorInThreads

See twisted.internet.interfaces.IReactorInThreads.callInThread.

def suggestThreadPoolSize(self, size): (source)
from twisted.internet.interfaces.IReactorThreads

See twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize.

def callFromThread(self, f, *args, **kw): (source)
from twisted.internet.interfaces.IReactorFromThreads
overridden in twisted.internet.asyncioreactor.AsyncioSelectorReactor

Cause a function to be executed by the reactor thread.

Use this method when you want to run a function in the reactor's thread from another thread. Calling callFromThread should wake up the main thread (where reactor.run() is executing) and run the given callable in that thread.

If you're writing a multi-threaded application the callable may need to be thread safe, but this method doesn't require it as such. If you want to call a function in the next mainloop iteration, but you're in the same thread, use callLater with a delay of 0.

API Documentation for Twisted, generated by pydoctor at 2018-10-15 19:29:43.