t.i._.GlibReactorBase(posixbase.PosixReactorBase, posixbase._PollLikeMixin) : class documentation

Part of twisted.internet._glibbase View Source View In Hierarchy

Known subclasses: twisted.internet.gireactor.GIReactor, twisted.internet.gtk2reactor.Gtk2Reactor

Implements interfaces: twisted.internet.interfaces.IReactorFDSet

Base class for GObject event loop reactors.

Notification for I/O events (reads and writes on file descriptors) is done by the the gobject-based event loop. File descriptors are registered with gobject with the appropriate flags for read/write/disconnect notification.

Time-based events, the results of callLater and callFromThread, are handled differently. Rather than registering each event with gobject, a single gobject timeout is registered for the earliest scheduled event, the output of reactor.timeout(). For example, if there are timeouts in 1, 2 and 3.4 seconds, a single timeout is registered for 1 second in the future. When this timeout is hit, _simulate is called, which calls the appropriate Twisted-level handlers, and a new timeout is added to gobject by the _reschedule method.

To handle callFromThread events, we use a custom waker that calls _simulate whenever it wakes up.

Method __init__ Undocumented
Method input_add Undocumented
Method addReader Add a FileDescriptor for monitoring of data available to read.
Method addWriter Add a FileDescriptor for monitoring ability to write data.
Method getReaders Retrieve the list of current FileDescriptor monitored for reading.
Method getWriters Retrieve the list of current FileDescriptor monitored for writing.
Method removeAll Remove monitoring for all registered FileDescriptors.
Method removeReader Stop monitoring the given FileDescriptor for reading.
Method removeWriter Stop monitoring the given FileDescriptor for writing.
Method iterate One iteration of the event loop, for trial's use.
Method crash Crash the reactor.
Method stop Stop the reactor.
Method run Run the reactor.
Method callLater Schedule a DelayedCall.
Instance Variable _sources A dictionary mapping FileDescriptor instances to GSource handles.
Instance Variable _reads A set of FileDescriptor instances currently monitored for reading.
Instance Variable _writes A set of FileDescriptor instances currently monitored for writing.
Instance Variable _simtag A GSource handle for the next simulate call.
Method _handleSignals Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
Method _ioEventCallback Called by event loop when an I/O event occurs.
Method _add No summary
Method _remove Remove monitoring the given FileDescriptor for either reading or writing. If it's still monitored for the other operation, we re-register the FileDescriptor for only that operation.
Method _reschedule Schedule a glib timeout for _simulate.
Method _simulate Run timers, and then reschedule glib timeout for next scheduled event.

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
Method listenUNIX
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 listenTCP
Method connectTCP
Method connectSSL
Method listenSSL
Instance Variable _childWaker None or a reference to the _SIGCHLDWaker which is used to properly notice child process termination.
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 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 Set the internal resolver to use to for name lookups.
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 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 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 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.IReactorThreads.callFromThread.
Method getThreadPool See twisted.internet.interfaces.IReactorThreads.getThreadPool.
Method callInThread See twisted.internet.interfaces.IReactorThreads.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.
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.
_sources =
A dictionary mapping FileDescriptor instances to GSource handles.
_reads =
A set of FileDescriptor instances currently monitored for reading.
_writes =
A set of FileDescriptor instances currently monitored for writing.
_simtag =
A GSource handle for the next simulate call.
def __init__(self, glib_module, gtk_module, useGtk=False): (source)
overrides twisted.internet.base.ReactorBase.__init__
overridden in twisted.internet.gireactor.GIReactor, twisted.internet.gtk2reactor.Gtk2Reactor
Undocumented
def _handleSignals(self): (source)
overrides twisted.internet.posixbase.PosixReactorBase._handleSignals
Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
def input_add(self, source, condition, callback): (source)
Undocumented
def _ioEventCallback(self, source, condition): (source)
Called by event loop when an I/O event occurs.
def _add(self, source, primary, other, primaryFlag, otherFlag): (source)
Add the given FileDescriptor for monitoring either for reading or writing. If the file is already monitored for the other operation, we delete the previous registration and re-register it for both reading and writing.
def addReader(self, reader): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.addReader
overridden in twisted.manhole.gladereactor.GladeReactor
Add a FileDescriptor for monitoring of data available to read.
def addWriter(self, writer): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.addWriter
overridden in twisted.manhole.gladereactor.GladeReactor
Add a FileDescriptor for monitoring ability to write data.
def getReaders(self): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.getReaders
Retrieve the list of current FileDescriptor monitored for reading.
def getWriters(self): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.getWriters
Retrieve the list of current FileDescriptor monitored for writing.
def removeAll(self): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.removeAll
Remove monitoring for all registered FileDescriptors.
def _remove(self, source, primary, other, flags): (source)
Remove monitoring the given FileDescriptor for either reading or writing. If it's still monitored for the other operation, we re-register the FileDescriptor for only that operation.
def removeReader(self, reader): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.removeReader
overridden in twisted.manhole.gladereactor.GladeReactor
Stop monitoring the given FileDescriptor for reading.
def removeWriter(self, writer): (source)
from twisted.internet.interfaces.IReactorFDSet
overrides twisted.internet.base.ReactorBase.removeWriter
overridden in twisted.manhole.gladereactor.GladeReactor
Stop monitoring the given FileDescriptor for writing.
def iterate(self, delay=0): (source)
from twisted.internet.interfaces.IReactorCore
overrides twisted.internet.base.ReactorBase.iterate
One iteration of the event loop, for trial's use.

This is not used for actual reactor runs.

def crash(self): (source)
from twisted.internet.interfaces.IReactorCore
overrides twisted.internet.base.ReactorBase.crash
overridden in twisted.manhole.gladereactor.GladeReactor
Crash the reactor.
def stop(self): (source)
from twisted.internet.interfaces.IReactorCore
overrides twisted.internet.base.ReactorBase.stop
Stop the reactor.
def run(self, installSignalHandlers=True): (source)
from twisted.internet.interfaces.IReactorCore
overrides twisted.internet.base._SignalReactorMixin.run
overridden in twisted.manhole.gladereactor.GladeReactor
Run the reactor.
def callLater(self, *args, **kwargs): (source)
from twisted.internet.interfaces.IReactorTime
overrides twisted.internet.base.ReactorBase.callLater
Schedule a DelayedCall.
def _reschedule(self): (source)
Schedule a glib timeout for _simulate.
def _simulate(self): (source)
Run timers, and then reschedule glib timeout for next scheduled event.
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.