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`.`cfreactor`.`_WakerPlus``

class documentation

`class _WakerPlus(_UnixWaker): (source)`

Constructor: `_WakerPlus(reactor)`

View In Hierarchy

The normal Twisted waker will simply wake up the main loop, which causes an iteration to run, which in turn causes `ReactorBase.runUntilCurrent` to get invoked.

`CFReactor` has a slightly different model of iteration, though: rather than have each iteration process the thread queue, then timed calls, then file descriptors, each callback is run as it is dispatched by the CFRunLoop observer which triggered it.

So this waker needs to not only unblock the loop, but also make sure the work gets done; so, it reschedules the invocation of `runUntilCurrent` to be immediate (0 seconds from now) even if there is no timed call work to do.

Method | `__init__` | Initialize.
Method | `doRead` | Wake up the loop and force `runUntilCurrent` to run immediately in the next timed iteration.
Instance Variable | `reactor` | Undocumented

Inherited from `_UnixWaker`:

Method | `wakeUp` | Write one byte to the pipe, and flush it.

Inherited from `_FDWaker` (via `_UnixWaker`):

Method | `connectionLost` | Close both ends of my pipe.
Class Variable | `disconnected` | Undocumented
Instance Variable | `fileno` | No summary
Instance Variable | `i` | The file descriptor which should be monitored in order to be awoken by this waker.
Instance Variable | `o` | The file descriptor for the end of the pipe which can be written to wake up a reactor monitoring this waker.

Inherited from `Logger` (via `_UnixWaker`, `_FDWaker`):

Method | `logPrefix` | Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.

def __init__(self, reactor): (source)
overrides `twisted.internet._signals._FDWaker.__init__`

Initialize.

def doRead(self): (source)
from `twisted.internet._signals._IWaker`
overrides `twisted.internet._signals._FDWaker.doRead`

Wake up the loop and force `runUntilCurrent` to run immediately in the next timed iteration.

reactor = (source)

Undocumented