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`.`proxy`.`ReverseProxyResource``

class documentation

`class ReverseProxyResource(Resource): (source)`

View In Hierarchy

Resource that renders the results gotten from another server

Put this resource in the tree to cause everything below it to be relayed to a different server.

Method | `__init__` | No summary
Method | `getChild` | Create and return a proxy resource with the same proxy configuration as this one, except that its path also contains the segment given by `path` at the end.
Method | `render` | Render a request by forwarding it to the proxied server.
Instance Variable | `host` | Undocumented
Instance Variable | `path` | Undocumented
Instance Variable | `port` | Undocumented
Instance Variable | `proxyClientFactoryClass` | a proxy client factory class, used to create new connections.
Instance Variable | `reactor` | the reactor used to create connections.

Inherited from `Resource`:

Method | `delEntity` | Undocumented
Method | `getChildForRequest` | Undocumented
Method | `getChildWithDefault` | Retrieve a static or dynamically generated child resource from me.
Method | `getDynamicEntity` | Undocumented
Method | `getStaticEntity` | Undocumented
Method | `listDynamicEntities` | Undocumented
Method | `listDynamicNames` | Undocumented
Method | `listEntities` | Undocumented
Method | `listNames` | Undocumented
Method | `listStaticEntities` | Undocumented
Method | `listStaticNames` | Undocumented
Method | `putChild` | Register a static child.
Method | `reallyPutEntity` | Undocumented
Method | `render_HEAD` | Default handling of HEAD method.
Class Variable | `isLeaf` | Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
Class Variable | `server` | Undocumented
Instance Variable | `children` | Undocumented

def __init__(self, host, port, path, reactor=reactor): (source)
overrides `twisted.web.resource.Resource.__init__`

Parameters
host:`str` | the host of the web server to proxy.
port:`port` | the port of the web server to proxy.
path:`bytes` | the base path to fetch data from. Note that you shouldn't put any trailing slashes in it, it will be added automatically in request. For example, if you put /foo, a request on /bar will be proxied to /foo/bar. Any required encoding of special characters (such as " " or "/") should have been done already.
reactor | Undocumented

def getChild(self, path, request): (source)
overrides `twisted.web.resource.Resource.getChild`

Create and return a proxy resource with the same proxy configuration as this one, except that its path also contains the segment given by `path` at the end.

def render(self, request): (source)
from `twisted.web.resource.IResource`
overrides `twisted.web.resource.Resource.render`

Render a request by forwarding it to the proxied server.

host = (source)

Undocumented

path = (source)

Undocumented

port = (source)

Undocumented

proxyClientFactoryClass: `ClientFactory` = (source)

a proxy client factory class, used to create new connections.

reactor: object providing `twisted.internet.interfaces.IReactorTCP` = (source)

the reactor used to create connections.