twisted.web.proxy.ReverseProxyResource : API documentation

class documentation

class twisted.web.proxy.ReverseProxyResource(Resource): (source)

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.

Instance Variable	proxyClientFactoryClass	a proxy client factory class, used to create new connections.
Instance Variable	reactor	the reactor used to create connections.
Method	__init__
Instance Variable	host	Undocumented
Instance Variable	port	Undocumented
Instance Variable	path	Undocumented
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.

Inherited from Resource:

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

proxyClientFactoryClass = (source)

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

(type: ClientFactory)

reactor = (source)

the reactor used to create connections.

(type: object providing twisted.internet.interfaces.IReactorTCP)

def __init__(self, host, port, path, reactor=reactor): (source)

overrides twisted.web.resource.Resource.__init__

Parameters	host	the host of the web server to proxy. (type: `str`)
	port	the port of the web server to proxy. (type: `port`)
	path	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. (type: `bytes`)
	reactor	Undocumented

host = (source)

Undocumented

port = (source)

Undocumented

path = (source)

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.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.