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

class documentation

`class ProxyAgent(_AgentBase): (source)`

Implements interfaces: `twisted.web.iweb.IAgent`

View In Hierarchy

An HTTP agent able to cross HTTP proxies.

Present Since
11.1

Method | `__init__` | Undocumented
Method | `request` | Issue a new request via the configured proxy.
Instance Variable | `_proxyEndpoint` | The endpoint used to connect to the proxy.

Inherited from `_AgentBase`:

Method | `_computeHostValue` | Compute the string to use for the value of the Host header, based on the given scheme, host name, and port number.
Method | `_requestWithEndpoint` | Issue a new request, given the endpoint and the path sent as part of the request.
Instance Variable | `_pool` | The `HTTPConnectionPool` used to manage HTTP connections.
Instance Variable | `_reactor` | The `IReactorTime` implementation which will be used by the pool, and perhaps by subclasses as well.

def __init__(self, endpoint, reactor=None, pool=None): (source)
overrides `twisted.web.client._AgentBase.__init__`

Undocumented

def request(self, method, uri, headers=None, bodyProducer=None): (source)
from `twisted.web.iweb.IAgent`

Issue a new request via the configured proxy.

_proxyEndpoint = (source)

The endpoint used to connect to the proxy.