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`.`win32eventreactor`.`_ThreadFDWrapper``

class documentation

`class _ThreadFDWrapper: (source)`

Constructor: `_ThreadFDWrapper(reactor, fd, action, logPrefix)`

View In Hierarchy

This wraps an event handler and translates notification in the helper `Win32Reactor` thread into a notification in the primary reactor thread.

Method | `__init__` | Undocumented
Method | `connectionLost` | Pass through to the wrapped descriptor, but in the main reactor thread instead of the helper `Win32Reactor` thread.
Method | `logPrefix` | Return the original handler's log prefix, as it was given to `__init__`.
Method | `_execute` | Callback fired when the associated event is set. Run the `action` callback on the wrapped descriptor in the main reactor thread and raise or return whatever it raises or returns to cause this event handler to be removed from ...
Instance Variable | `_action` | A `str` giving the method of `_fd` which handles the event.
Instance Variable | `_fd` | The `FileDescriptor` to which the event will be dispatched.
Instance Variable | `_logPrefix` | The pre-fetched log prefix string for `_fd`, so that `_fd.logPrefix` does not need to be called in a non-main thread.
Instance Variable | `_reactor` | The primary reactor, the one to which event notification will be sent.

def __init__(self, reactor, fd, action, logPrefix): (source)

Undocumented

def connectionLost(self, reason): (source)

Pass through to the wrapped descriptor, but in the main reactor thread instead of the helper `Win32Reactor` thread.

def logPrefix(self): (source)

Return the original handler's log prefix, as it was given to `__init__`.

def _execute(self): (source)

Callback fired when the associated event is set. Run the `action` callback on the wrapped descriptor in the main reactor thread and raise or return whatever it raises or returns to cause this event handler to be removed from `self._reactor` if appropriate.

_action = (source)

A `str` giving the method of `_fd` which handles the event.

_fd = (source)

The `FileDescriptor` to which the event will be dispatched.

_logPrefix = (source)

The pre-fetched log prefix string for `_fd`, so that `_fd.logPrefix` does not need to be called in a non-main thread.

_reactor = (source)

The primary reactor, the one to which event notification will be sent.