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`.`web`.`client`.`_GzipProtocol``

class documentation

`class _GzipProtocol(proxyForInterface(IProtocol)): (source)`

View In Hierarchy

A `Protocol` implementation which wraps another one, transparently decompressing received data.

Present Since
11.1

Method | `__init__` | Undocumented
Method | `connectionLost` | Forward the connection lost event, flushing remaining data from the decompressor if any.
Method | `dataReceived` | Decompress `data` with the zlib decompressor, forwarding the raw data to the original protocol.
Instance Variable | `original` | Undocumented
Instance Variable | `_response` | A reference to the original response, in case of errors.
Instance Variable | `_zlibDecompress` | A zlib decompress object used to decompress the data stream.

def __init__(self, protocol, response): (source)

Undocumented

def connectionLost(self, reason): (source)

Forward the connection lost event, flushing remaining data from the decompressor if any.

def dataReceived(self, data): (source)

Decompress `data` with the zlib decompressor, forwarding the raw data to the original protocol.

original = (source)

Undocumented

_response = (source)

A reference to the original response, in case of errors.

_zlibDecompress = (source)

A zlib decompress object used to decompress the data stream.