twisted.internet.win32eventreactor.Win32Reactor

class documentation

class Win32Reactor(posixbase.PosixReactorBase): (source)

Implements interfaces: twisted.internet.interfaces.IReactorFDSet, twisted.internet.interfaces.IReactorWin32Events

View In Hierarchy

Reactor that uses Win32 event APIs.

Method __init__ Undocumented
Method addEvent Add a new win32 event to the event loop.
Method addReader Add a socket FileDescriptor for notification of data available to read.
Method addWriter Add a socket FileDescriptor for notification of data available to write.
Method doWaitForMultipleEvents Undocumented
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 selectables, and return a list of them.
Method removeEvent Remove an event.
Method removeReader Remove a Selectable for notification of data available to read.
Method removeWriter Remove a Selectable for notification of data available to write.
Class Variable dummyEvent Undocumented
Method _makeSocketEvent Make a win32 event object for a socket.
Method _runAction Undocumented
Method _runWrite Undocumented
Instance Variable _closedAndNotReading These descriptors have had close notification delivered from the OS, but are not marked as allowed to handle read events in the reactor. They are saved here to record their closed state, but not processed at all...
Instance Variable _closedAndReading Along with _closedAndNotReading, keeps track of descriptors which have had close notification delivered from the OS but which we have not finished reading data from. MsgWaitForMultipleObjects will only deliver close notification to us once, so we remember it in these two dictionaries until we're ready to act on it...
Instance Variable _events A dictionary mapping win32 event object to tuples of FileDescriptor instances and event masks.
Instance Variable _reads A dictionary mapping FileDescriptor instances to a win32 event object used to check for read events for that descriptor.
Instance Variable _writes A dictionary mapping FileDescriptor instances to a arbitrary value. Keys in this dictionary will be given a chance to write out their data.

Inherited from PosixReactorBase:

Method adoptDatagramPort Add an existing listening SOCK_DGRAM socket to the reactor to monitor for read and write readiness.
Method adoptStreamConnection No summary
Method adoptStreamPort Create a new IListeningPort from an already-initialized socket.
Method connectSSL Connect a client Protocol to a remote SSL socket.
Method connectTCP Connect a TCP client.
Method connectUNIX Connect a client protocol to a UNIX socket.
Method connectUNIXDatagram Connects a ConnectedDatagramProtocol instance to a path.
Method installWaker Install a `waker' to allow threads and signals to wake up the IO thread.
Method listenMulticast Connects a given DatagramProtocol to the given numeric UDP port.
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.
Method listenTCP Connects a given protocol factory to the given numeric TCP/IP port.
Method listenUDP Connects a given DatagramProtocol to the given numeric UDP port.
Method listenUNIX Listen on a UNIX socket.
Method listenUNIXDatagram Connects a given DatagramProtocol to the given path.
Method spawnProcess Spawn a process, with a process protocol.
Instance Variable waker Undocumented
Method _removeAll Remove all readers and writers, and list of removed IReadDescriptors and IWriteDescriptors.
Method _signalsFactory Customize reactor signal handling to support child processes on POSIX platforms.
Method _wakerFactory Undocumented
Class Variable _supportedAddressFamilies Undocumented
Instance Variable _childWaker None or a reference to the _SIGCHLDWaker which is used to properly notice child process termination.

Inherited from _DisconnectSelectableMixin (via PosixReactorBase):

Method _disconnectSelectable Utility function for disconnecting a selectable.

Inherited from ReactorBase (via PosixReactorBase, _DisconnectSelectableMixin):

Method addSystemEventTrigger See twisted.internet.interfaces.IReactorCore.addSystemEventTrigger.
Method callFromThread See twisted.internet.interfaces.IReactorFromThreads.callFromThread.
Method callInThread See twisted.internet.interfaces.IReactorInThreads.callInThread.
Method callLater See twisted.internet.interfaces.IReactorTime.callLater.
Method callWhenRunning See twisted.internet.interfaces.IReactorCore.callWhenRunning.
Method crash See twisted.internet.interfaces.IReactorCore.crash.
Method disconnectAll Disconnect every reader, and writer in the system.
Method doIteration Do one iteration over the readers and writers which have been added.
Method fireSystemEvent See twisted.internet.interfaces.IReactorCore.fireSystemEvent.
Method getDelayedCalls See twisted.internet.interfaces.IReactorTime.getDelayedCalls
Method getThreadPool See twisted.internet.interfaces.IReactorThreads.getThreadPool.
Method iterate See twisted.internet.interfaces.IReactorCore.iterate.
Method mainLoop Undocumented
Method removeSystemEventTrigger 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 runUntilCurrent Run all pending timed calls.
Method sigBreak Handle a SIGBREAK interrupt.
Method sigInt Handle a SIGINT interrupt.
Method sigTerm Handle a SIGTERM interrupt.
Method startRunning Method called when reactor starts: do some initialization and fire startup events.
Method stop See twisted.internet.interfaces.IReactorCore.stop.
Method suggestThreadPoolSize 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 wakeUp 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 threadCallQueue Undocumented
Instance Variable threadpool Undocumented
Instance Variable threadpoolShutdownID Undocumented
Instance Variable usingThreads Undocumented
Method _addInternalReader Add a read descriptor which is part of the implementation of the reactor itself.
Method _cancelCallLater Undocumented
Method _initThreadPool Create the threadpool accessible with callFromThread.
Method _initThreads Undocumented
Method _insertNewDelayedCalls Undocumented
Method _makeSignalHandling Get an appropriate signal handling object.
Method _moveCallLaterSooner Undocumented
Method _reallyStartRunning Method called to transition to the running state. This should happen in the during startup event trigger phase.
Method _removeInternalReader Remove a read descriptor which is part of the implementation of the reactor itself.
Method _stopThreadPool 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 ...
Method _uninstallHandler Undocumented
Class Variable _lock Undocumented
Instance Variable _cancellations Undocumented
Instance Variable _eventTriggers Undocumented
Instance Variable _exitSignal See _ISupportsExitSignalCapturing._exitSignal
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
Instance Variable _internalReaders Undocumented
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...
Instance Variable _newTimedCalls Undocumented
Instance Variable _pendingTimedCalls Undocumented
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 _signals An object which knows how to install and uninstall the reactor's signal-handling behavior.
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 _startedBefore 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 _threadpoolStartupID Undocumented

Inherited from PluggableResolverMixin (via PosixReactorBase, _DisconnectSelectableMixin, ReactorBase):

Method installNameResolver See IReactorPluggableNameResolver.
Method installResolver See IReactorPluggableResolver.
Instance Variable resolver The installed IResolverSimple.
Property nameResolver Implementation of read-only IReactorPluggableNameResolver.nameResolver.
Instance Variable _nameResolver The installed IHostnameResolver.
def __init__(self): (source)
overrides twisted.internet.base.ReactorBase.__init__

Undocumented

def addEvent(self, event, fd, action): (source)
from twisted.internet.interfaces.IReactorWin32Events

Add a new win32 event to the event loop.

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

Add a socket 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 socket FileDescriptor for notification of data available to write.

def doWaitForMultipleEvents(self, timeout): (source)

Undocumented

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 removeEvent(self, event): (source)
from twisted.internet.interfaces.IReactorWin32Events

Remove an event.

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.

dummyEvent = (source)

Undocumented

def _makeSocketEvent(self, fd, action, why): (source)

Make a win32 event object for a socket.

def _runAction(self, action, fd): (source)

Undocumented

def _runWrite(self, fd): (source)

Undocumented

_closedAndNotReading: WeakKeyDictionary = (source)

These descriptors have had close notification delivered from the OS, but are not marked as allowed to handle read events in the reactor. They are saved here to record their closed state, but not processed at all. When one of these descriptors is passed to IReactorFDSet.addReader, it is moved out of this dictionary and into _closedAndReading. The descriptors are keys in this dictionary. The values are arbitrary. This is a weak key dictionary so that if an application tells the reactor to stop reading from a descriptor and then forgets about that descriptor itself, the reactor will also forget about it.

_closedAndReading: dict = (source)

Along with _closedAndNotReading, keeps track of descriptors which have had close notification delivered from the OS but which we have not finished reading data from. MsgWaitForMultipleObjects will only deliver close notification to us once, so we remember it in these two dictionaries until we're ready to act on it. The OS has delivered close notification for each descriptor in this dictionary, and the descriptors are marked as allowed to handle read events in the reactor, so they can be processed. When a descriptor is marked as not allowed to handle read events in the reactor (ie, it is passed to IReactorFDSet.removeReader), it is moved out of this dictionary and into _closedAndNotReading. The descriptors are keys in this dictionary. The values are arbitrary.

_events: dict = (source)

A dictionary mapping win32 event object to tuples of FileDescriptor instances and event masks.

_reads: dict = (source)

A dictionary mapping FileDescriptor instances to a win32 event object used to check for read events for that descriptor.

_writes: dict = (source)

A dictionary mapping FileDescriptor instances to a arbitrary value. Keys in this dictionary will be given a chance to write out their data.