Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`internet`.`pollreactor`.`PollReactor``

class documentation

`class PollReactor(posixbase.PosixReactorBase, posixbase._PollLikeMixin): (source)`

Implements interfaces: `twisted.internet.interfaces.IReactorFDSet`

View In Hierarchy

A reactor that uses poll(2).

Method | `__init__` | Initialize polling object, file descriptor tracking dictionaries, and the base class.
Method | `addReader` | Add a FileDescriptor for notification of data available to read.
Method | `addWriter` | Add a FileDescriptor for notification of data available to write.
Method | `doPoll` | Poll the poller for new events.
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 | `removeReader` | Remove a Selectable for notification of data available to read.
Method | `removeWriter` | Remove a Selectable for notification of data available to write.
Method | `_dictRemove` | Undocumented
Method | `_updateRegistration` | Register/unregister an fd with the poller.
Constant | `_POLL_DISCONNECTED` | Undocumented
Instance Variable | `_poller` | A `select.poll` which will be used to check for I/O readiness.
Instance Variable | `_reads` | A dictionary mapping integer file descriptors to arbitrary values (this is essentially a set). Keys in this dictionary will be registered with `_poller` for read readiness notifications which will be dispatched to the corresponding ...
Instance Variable | `_selectables` | A dictionary mapping integer file descriptors to instances of `FileDescriptor` which have been registered with the reactor. All `FileDescriptor`s which are currently receiving read or write readiness notifications will be present as values in this dictionary.
Instance Variable | `_writes` | A dictionary mapping integer file descriptors to arbitrary values (this is essentially a set). Keys in this dictionary will be registered with `_poller` for write readiness notifications which will be dispatched to the corresponding ...

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 | `_handleSignals` | Extend the basic signal handling logic to also support handling SIGCHLD to know when to try to reap child processes.
Method | `_removeAll` | Remove all readers and writers, and list of removed `IReadDescriptor`s and `IWriteDescriptor`s.
Method | `_uninstallHandler` | If a child waker was created and installed, uninstall it now.
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 `_SignalReactorMixin` (via `PosixReactorBase`):

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

Inherited from `_DisconnectSelectableMixin` (via `PosixReactorBase`, `_SignalReactorMixin`):

Method | `_disconnectSelectable` | Utility function for disconnecting a selectable.

Inherited from `ReactorBase` (via `PosixReactorBase`, `_SignalReactorMixin`, `_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 | `removeSystemEventTrigger` | See twisted.internet.interfaces.IReactorCore.removeSystemEventTrigger.
Method | `resolve` | Return a Deferred that will resolve a hostname.
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 | `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 | `_cancelCallLater` | Undocumented
Method | `_initThreadPool` | Create the threadpool accessible with callFromThread.
Method | `_initThreads` | Undocumented
Method | `_insertNewDelayedCalls` | Undocumented
Method | `_moveCallLaterSooner` | Undocumented
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 ...
Class Variable | `_lock` | Undocumented
Instance Variable | `_cancellations` | Undocumented
Instance Variable | `_eventTriggers` | Undocumented
Instance Variable | `_exitSignal` | See `_ISupportsExitSignalCapturing._exitSignal`
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 | `_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`, `_SignalReactorMixin`, `_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`.

Inherited from `_PollLikeMixin` (via `PosixReactorBase`, `_SignalReactorMixin`, `_DisconnectSelectableMixin`, `ReactorBase`, `PluggableResolverMixin`):

Method | `_doReadOrWrite` | fd is available for read or write, do the work and raise errors if necessary.

def __init__(self): (source)
overrides `twisted.internet.base.ReactorBase.__init__`

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

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

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

def doPoll(self, timeout): (source)

Poll the poller for new events.

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 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.

def _dictRemove(self, selectable, mdict): (source)

Undocumented

def _updateRegistration(self, fd): (source)

Register/unregister an fd with the poller.

_POLL_DISCONNECTED = (source)

Undocumented

Value

    (POLLHUP|POLLERR)|POLLNVAL

_poller = (source)

A `select.poll` which will be used to check for I/O readiness.

_reads: `dict` = (source)

A dictionary mapping integer file descriptors to arbitrary values (this is essentially a set). Keys in this dictionary will be registered with `_poller` for read readiness notifications which will be dispatched to the corresponding `FileDescriptor` instances in `_selectables`.

_selectables: `dict` = (source)

A dictionary mapping integer file descriptors to instances of `FileDescriptor` which have been registered with the reactor. All `FileDescriptor`s which are currently receiving read or write readiness notifications will be present as values in this dictionary.

_writes: `dict` = (source)

A dictionary mapping integer file descriptors to arbitrary values (this is essentially a set). Keys in this dictionary will be registered with `_poller` for write readiness notifications which will be dispatched to the corresponding `FileDescriptor` instances in `_selectables`.