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`.`haproxy``

package documentation
(source)

HAProxy PROXY protocol implementations.

Module | `_exceptions` | HAProxy specific exceptions.
Module | `_info` | IProxyInfo implementation.
Module | `_interfaces` | Interfaces used by the PROXY protocol modules.
Module | `_parser` | Parser for 'haproxy:' string endpoint.
Module | `_v1parser` | IProxyParser implementation for version one of the PROXY protocol.
Module | `_v2parser` | IProxyParser implementation for version two of the PROXY protocol.
Module | `_wrapper` | Protocol wrapper that provides HAProxy PROXY protocol support.

From `__init__.py`:

Function | `proxyEndpoint` | Wrap an endpoint with PROXY protocol support, so that the transport's `getHost` and `getPeer` methods reflect the attributes of the proxied connection rather than the underlying connection.

def proxyEndpoint(wrappedEndpoint: `interfaces.IStreamServerEndpoint`) -> `_WrapperServerEndpoint`: (source)

Wrap an endpoint with PROXY protocol support, so that the transport's `getHost` and `getPeer` methods reflect the attributes of the proxied connection rather than the underlying connection.

Parameters
wrappedEndpoint:`IStreamServerEndpoint` | The underlying listening endpoint.
Returns
`IStreamServerEndpoint` | a new listening endpoint that speaks the PROXY protocol.