t.i.g.GtkReactor(posixbase.PosixReactorBase) : class documentation

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

Implements interfaces: twisted.internet.interfaces.IReactorFDSet

GTK+ event loop reactor.
Method __init__ Initialize the file descriptor tracking dictionaries and the base class.
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.
Method doIterationTimeout Undocumented
Method doIteration Do one iteration over the readers and writers which have been added.
Method crash See twisted.internet.interfaces.IReactorCore.crash.
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 callback Undocumented
Method simulate Run simulation loops and reschedule callbacks.
Instance Variable _reads A dictionary mapping FileDescriptor instances to gtk INPUT_READ watch handles.
Instance Variable _writes A dictionary mapping FileDescriptor instances to gtk INTPUT_WRITE watch handles.
Instance Variable _simtag A gtk timeout handle for the next simulate call.
Method _readAndWrite Undocumented

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 _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 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 resolve Return a Deferred that will resolve a hostname.
Method stop See twisted.internet.interfaces.IReactorCore.stop.
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.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
_reads =
A dictionary mapping FileDescriptor instances to gtk INPUT_READ watch handles.
_writes =
A dictionary mapping FileDescriptor instances to gtk INTPUT_WRITE watch handles.
_simtag =
A gtk timeout handle for the next simulate call.
def __init__(self): (source)
Initialize the file descriptor tracking dictionaries and the base class.
def addReader(self, reader): (source)
I add reader to the set of file descriptors to get read events for.
ParametersreaderAn IReadDescriptor provider that will be checked for read events until it is removed from the reactor with removeReader.
ReturnsNone.
def addWriter(self, writer): (source)
I add writer to the set of file descriptors to get write events for.
ParameterswriterAn IWriteDescriptor provider that will be checked for write events until it is removed from the reactor with removeWriter.
ReturnsNone.
def getReaders(self): (source)
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)
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 removeAll(self): (source)
Remove all readers and writers.

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

ReturnsA list of IReadDescriptor and IWriteDescriptor providers which were removed.
def removeReader(self, reader): (source)
Removes an object previously added with addReader.
ReturnsNone.
def removeWriter(self, writer): (source)
Removes an object previously added with addWriter.
ReturnsNone.
def doIterationTimeout(self, *args): (source)
Undocumented
def doIteration(self, delay): (source)
Do one iteration over the readers and writers which have been added.
def crash(self): (source)
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 run(self, installSignalHandlers=1): (source)
Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with stop() or crash().
def _readAndWrite(self, source, condition): (source)
Undocumented
def callback(self, source, condition): (source)
Undocumented
def simulate(self): (source)
Run simulation loops and reschedule callbacks.
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.