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`.`_pollingfile`.`_PollableReadPipe``

class documentation

`class _PollableReadPipe(_PollableResource): (source)`

Constructor: `_PollableReadPipe(pipe, receivedCallback, lostCallback)`

Implements interfaces: `twisted.internet.interfaces.IPushProducer`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `checkWork` | Undocumented
Method | `cleanup` | Undocumented
Method | `close` | Undocumented
Method | `pauseProducing` | Pause producing data.
Method | `resumeProducing` | Resume producing data.
Method | `stopProducing` | Stop producing data.
Instance Variable | `lostCallback` | Undocumented
Instance Variable | `pipe` | Undocumented
Instance Variable | `receivedCallback` | Undocumented

Inherited from `_PollableResource`:

Method | `activate` | Undocumented
Method | `deactivate` | Undocumented
Instance Variable | `active` | Undocumented

def __init__(self, pipe, receivedCallback, lostCallback): (source)

Undocumented

def checkWork(self): (source)

Undocumented

def cleanup(self): (source)

Undocumented

def close(self): (source)

Undocumented

def pauseProducing(self): (source)
from `twisted.internet.interfaces.IPushProducer`

Pause producing data.

Tells a producer that it has produced too much data to process for the time being, and to stop until `resumeProducing()` is called.

def resumeProducing(self): (source)
from `twisted.internet.interfaces.IPushProducer`

Resume producing data.

This tells a producer to re-add itself to the main loop and produce more data for its consumer.

def stopProducing(self): (source)
from `twisted.internet.interfaces.IProducer`

Stop producing data.

This tells a producer that its consumer has died, so it must stop producing data for good.

lostCallback = (source)

Undocumented

pipe = (source)

Undocumented

receivedCallback = (source)

Undocumented