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`.`protocols`.`htb`.`ShapedTransport``

class documentation

`class ShapedTransport(ShapedConsumer): (source)`

View In Hierarchy

Wraps a `Transport` and shapes the rate at which it receives data.

This is a `ShapedConsumer` with a little bit of magic to provide for the case where the consumer it wraps is also a `Transport` and people will be attempting to access attributes this does not proxy as a `Consumer` (e.g. `loseConnection`).

Method | `__getattr__` | Undocumented
Class Variable | `iAmStreaming` | Undocumented

Inherited from `ShapedConsumer`:

Method | `__init__` | Undocumented
Method | `stopProducing` | Stop producing data.
Instance Variable | `bucket` | Undocumented
Method | `_writeSomeData` | Write as much of this data as possible.

Inherited from `ProducerConsumerProxy` (via `ShapedConsumer`):

Method | `pauseProducing` | Undocumented
Method | `registerProducer` | Register to receive data from a producer.
Method | `resumeProducing` | Undocumented
Method | `unregisterProducer` | Stop consuming data from a producer, without disconnecting.
Method | `write` | The producer will write data by calling this method.
Class Variable | `bufferSize` | Undocumented
Instance Variable | `outstandingPull` | Undocumented
Instance Variable | `paused` | Undocumented
Instance Variable | `producerPaused` | Undocumented
Instance Variable | `unregistered` | Undocumented

Inherited from `BasicProducerConsumerProxy` (via `ShapedConsumer`, `ProducerConsumerProxy`):

Method | `__repr__` | Undocumented
Method | `finish` | Undocumented
Class Variable | `stopped` | Undocumented
Instance Variable | `consumer` | the Consumer I publish to.
Instance Variable | `producer` | the Producer I subscribe to.
Instance Variable | `producerIsStreaming` | Undocumented
Instance Variable | `_buffer` | Undocumented

def __getattr__(self, name): (source)

Undocumented

iAmStreaming: `bool` = (source)
overrides `twisted.protocols.htb.ShapedConsumer.iAmStreaming`

Undocumented