class documentation

class twisted.internet.iocpreactor.reactor.IOCPReactor(base._SignalReactorMixin, base.ReactorBase, _ThreadedWin32EventsMixin): (source)

Implements interfaces: twisted.internet.interfaces.IReactorMulticast, twisted.internet.interfaces.IReactorProcess, twisted.internet.interfaces.IReactorTCP, twisted.internet.interfaces.IReactorUDP

View In Hierarchy

Undocumented

Instance Variable port Undocumented
Method __init__ Undocumented
Instance Variable handles Undocumented
Method addActiveHandle Undocumented
Method removeActiveHandle Undocumented
Method doIteration Poll the IO completion port for new events.
Method installWaker Undocumented
Method wakeUp Wake up the event loop.
Method registerHandle Undocumented
Method createSocket Undocumented
Method listenTCP
Method connectTCP
Method listenSSL Non-implementation of IReactorSSL.listenSSL. Some dependency is not satisfied. This implementation always raises NotImplementedError.
Method connectSSL Non-implementation of IReactorSSL.connectSSL. Some dependency is not satisfied. This implementation always raises NotImplementedError.
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 spawnProcess Spawn a process.
Method removeAll Undocumented
Method _callEventCallback Undocumented

Inherited from _SignalReactorMixin:

Method startRunning Extend the base implementation in order to remember whether signal handlers should be installed later.
Method run Undocumented
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.
Method _handleSignals Install the signal handlers for the Twisted event loop.
Method _reallyStartRunning Extend the base implementation by also installing signal handlers, if self._installSignalHandlers is true.

Inherited from ReactorBase:

Instance Variable running See IReactorCore.running
Class Variable installed Undocumented
Instance Variable usingThreads Undocumented
Class Variable __name__ Undocumented
Instance Variable threadCallQueue Undocumented
Instance Variable waker Undocumented
Method addReader Undocumented
Method addWriter Undocumented
Method removeReader Undocumented
Method removeWriter 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 run Undocumented
Class Variable seconds Undocumented
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.
Instance Variable threadpool Undocumented
Instance Variable threadpoolShutdownID Undocumented
Method callFromThread Undocumented
Method getThreadPool See twisted.internet.interfaces.IReactorThreads.getThreadPool.
Method callInThread See twisted.internet.interfaces.IReactorInThreads.callInThread.
Method suggestThreadPoolSize See twisted.internet.interfaces.IReactorThreads.suggestThreadPoolSize.
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 _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.
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 _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
Instance Variable _eventTriggers Undocumented
Instance Variable _pendingTimedCalls Undocumented
Instance Variable _newTimedCalls Undocumented
Instance Variable _cancellations Undocumented
Instance Variable _startedBefore Undocumented
Instance Variable _internalReaders Undocumented
Class Variable _lock Undocumented
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.
Instance Variable _threadpoolStartupID Undocumented
Method _initThreads Undocumented
Method _initThreadPool Create the threadpool accessible with callFromThread.
Method _uninstallHandler Undocumented
Method _stopThreadPool No summary

Inherited from PluggableResolverMixin (via ReactorBase):

Instance Variable resolver The installed IResolverSimple.
Method installResolver See IReactorPluggableResolver.
Method installNameResolver See IReactorPluggableNameResolver.
Property nameResolver Implementation of read-only IReactorPluggableNameResolver.nameResolver.
Instance Variable _nameResolver The installed IHostnameResolver.

Inherited from _ThreadedWin32EventsMixin:

Method addEvent
Method removeEvent
Instance Variable _reactor The Win32Reactor running in the other thread. This is None until it is actually needed.
Instance Variable _reactorThread The threading.Thread which is running the Win32Reactor. This is None until it is actually needed.
Method _unmakeHelperReactor Stop and discard the reactor started by _makeHelperReactor.
Method _makeHelperReactor Create and (in a new thread) start a Win32Reactor instance to use for the implementation of IReactorWin32Events.
port = (source)

Undocumented

def __init__(self): (source)
handles = (source)

Undocumented

(type: set)
def addActiveHandle(self, handle): (source)

Undocumented

def removeActiveHandle(self, handle): (source)

Undocumented

def doIteration(self, timeout): (source)

Poll the IO completion port for new events.

def _callEventCallback(self, rc, numBytes, evt): (source)

Undocumented

def installWaker(self): (source)
def wakeUp(self): (source)

Wake up the event loop.

def registerHandle(self, handle): (source)

Undocumented

def createSocket(self, af, stype): (source)

Undocumented

def listenTCP(self, port, factory, backlog=50, interface=''): (source)
See Alsotwisted.internet.interfaces.IReactorTCP.listenTCP
def connectTCP(self, host, port, factory, timeout=30, bindAddress=None): (source)
See Alsotwisted.internet.interfaces.IReactorTCP.connectTCP
def listenSSL(self, port, factory, contextFactory, backlog=50, interface=''): (source)

Non-implementation of IReactorSSL.listenSSL. Some dependency is not satisfied. This implementation always raises NotImplementedError.

def connectSSL(self, host, port, factory, contextFactory, timeout=30, bindAddress=None): (source)

Non-implementation of IReactorSSL.connectSSL. Some dependency is not satisfied. This implementation always raises NotImplementedError.

def listenUDP(self, port, protocol, interface='', maxPacketSize=8192): (source)

Connects a given DatagramProtocol to the given numeric UDP port.

Returnsobject conforming to IListeningPort.
def listenMulticast(self, port, protocol, interface='', maxPacketSize=8192, listenMultiple=False): (source)

Connects a given DatagramProtocol to the given numeric UDP port.

EXPERIMENTAL.

Returnsobject conforming to IListeningPort.
def spawnProcess(self, processProtocol, executable, args=(), env={}, path=None, uid=None, gid=None, usePTY=0, childFDs=None): (source)
def removeAll(self): (source)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.