class documentation

class twisted.internet.kqreactor.KQueueReactor(posixbase.PosixReactorBase): (source)

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

View In Hierarchy

A reactor that uses kqueue(2)/kevent(2) and relies on Python 2.6 or higher which has built in support for kqueue in the select module.

Method __init__ Initialize kqueue object, file descriptor tracking dictionaries, and the base class.
Method beforeDaemonize Implement IReactorDaemonize.beforeDaemonize.
Method afterDaemonize Implement IReactorDaemonize.afterDaemonize.
Method addReader Implement IReactorFDSet.addReader.
Method addWriter Implement IReactorFDSet.addWriter.
Method removeReader Implement IReactorFDSet.removeReader.
Method removeWriter Implement IReactorFDSet.removeWriter.
Method removeAll Implement IReactorFDSet.removeAll.
Method getReaders Implement IReactorFDSet.getReaders.
Method getWriters Implement IReactorFDSet.getWriters.
Method doKEvent Poll the kqueue for new events.
Instance Variable _kq A kqueue which will be used to check for I/O readiness.
Instance Variable _impl The implementation of _IKQueue to use.
Instance Variable _selectables A dictionary mapping integer file descriptors to instances of FileDescriptor which have been registered with the reactor. All FileDescriptors which are currently receiving read or write readiness notifications will be present as values in this dictionary.
Instance Variable _reads A set containing integer file descriptors. Values in this set will be registered with _kq for read readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
Instance Variable _writes A set containing integer file descriptors. Values in this set will be registered with _kq for write readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
Method _updateRegistration Private method for changing kqueue registration on a given FD filtering for events given filter/op. This will never block and returns nothing.
Method _doWriteOrRead Private method called when a FD is ready for reading, writing or was lost. Do the work and raise errors where necessary.

Inherited from PosixReactorBase:

Method installWaker Install a `waker' to allow threads and signals to wake up the IO thread.
Instance Variable waker Undocumented
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 Connect a client protocol to a UNIX socket.
Method listenUNIX Listen on a UNIX socket.
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 adoptDatagramPort Add an existing listening SOCK_DGRAM socket to the reactor to monitor for read and write readiness.
Method listenTCP Connects a given protocol factory to the given numeric TCP/IP port.
Method connectTCP Connect a TCP client.
Method connectSSL Connect a client Protocol to a remote SSL socket.
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.
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.
Class Variable _supportedAddressFamilies Undocumented
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 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 _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
Class Variable installed Undocumented
Instance Variable usingThreads Undocumented
Class Variable __name__ Undocumented
Instance Variable threadCallQueue Undocumented
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 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 _stopThreadPool No summary

Inherited from PluggableResolverMixin (via PosixReactorBase, 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.
A kqueue which will be used to check for I/O readiness.
_impl = (source)
The implementation of _IKQueue to use.
_selectables = (source)
A dictionary mapping integer file descriptors to instances of FileDescriptor which have been registered with the reactor. All FileDescriptors which are currently receiving read or write readiness notifications will be present as values in this dictionary.
(type: dict)
_reads = (source)
A set containing integer file descriptors. Values in this set will be registered with _kq for read readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
(type: set)
_writes = (source)
A set containing integer file descriptors. Values in this set will be registered with _kq for write readiness notifications which will be dispatched to the corresponding FileDescriptor instances in _selectables.
(type: set)
def __init__(self, _kqueueImpl=select): (source)

Initialize kqueue object, file descriptor tracking dictionaries, and the base class.

See:

  • http://docs.python.org/library/select.html
  • www.freebsd.org/cgi/man.cgi?query=kqueue
  • people.freebsd.org/~jlemon/papers/kqueue.pdf
Parameters_kqueueImplThe implementation of _IKQueue to use. A hook for testing.
def _updateRegistration(self, fd, filter, op): (source)

Private method for changing kqueue registration on a given FD filtering for events given filter/op. This will never block and returns nothing.

def doKEvent(self, timeout): (source)

Poll the kqueue for new events.

def _doWriteOrRead(self, selectable, fd, event): (source)

Private method called when a FD is ready for reading, writing or was lost. Do the work and raise errors where necessary.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.