twisted.web.proxy.ProxyRequest(Request) class documentationtwisted.web.proxy
View Source
(View In Hierarchy)
Used by Proxy to implement a simple web proxy.
| Instance Variable | reactor | the reactor used to create connections. (type: object providing twisted.internet.interfaces.IReactorTCP) |
| Method | __init__ | |
| Method | process | Override in subclasses. |
Inherited from Request:
| Instance Variable | method | The HTTP method that was used. |
| Instance Variable | uri | The full URI that was requested (includes arguments). |
| Instance Variable | path | The path only (arguments not included). |
| Instance Variable | args | All of the arguments, including URL and POST arguments. (type: A mapping of strings (the argument names) to lists of values. i.e., ?foo=bar&foo=baz&quux=spam results in {'foo': ['bar', 'baz'], 'quux': ['spam']}.) |
| Instance Variable | cookies | The cookies that will be sent in the response. (type: list
of bytes) |
| Instance Variable | requestHeaders | All received HTTP request headers. (type: http_headers.Headers) |
| Instance Variable | responseHeaders | All HTTP response headers to be sent. (type: http_headers.Headers) |
| Instance Variable | notifications | A list of Deferreds
which are waiting for notification that the response to this request has
been finished (successfully or with an error). Don't use this attribute
directly, instead use the Request.notifyFinish
method. |
| Method | noLongerQueued | Notify the object that it is no longer queued. |
| Method | gotLength | Called when HTTP channel got length of content in this request. |
| Method | parseCookies | Parse cookie headers. |
| Method | handleContentChunk | Write a chunk of data. |
| Method | requestReceived | Called by channel when all data has been received. |
| Method | __repr__ | Return a string description of the request including such information as the request method and request URI. |
| Method | registerProducer | Register a producer. |
| Method | unregisterProducer | Unregister the producer. |
| Method | getHeader | Get an HTTP request header. |
| Method | getCookie | Get a cookie that was sent from the network. |
| Method | notifyFinish | Notify when the response to this request has finished. |
| Method | finish | Indicate that all response data has been written to this Request. |
| Method | write | Write some data as a result of an HTTP request. The first time this is called, it writes out response data. |
| Method | addCookie | Set an outgoing HTTP cookie. |
| Method | setResponseCode | Set the HTTP response code. |
| Method | setHeader | Set an HTTP response header. Overrides any previously set values for this header. |
| Method | redirect | Utility function that does a redirect. |
| Method | setLastModified | Set the Last-Modified time for the response to this
request. |
| Method | setETag | Set an entity tag for the outgoing response. |
| Method | getAllHeaders | Return dictionary mapping the names of all received headers to the last value received for each. |
| Method | getRequestHostname | Get the hostname that the user passed in to the request. |
| Method | getHost | Get my originally requesting transport's host. |
| Method | setHost | Change the host and port the request thinks it's using. |
| Method | getClientIP | Return the IP address of the client who submitted this request. |
| Method | isSecure | Return True
if this request is using a secure transport. |
| Method | getUser | Return the HTTP user sent with this request, if any. |
| Method | getPassword | Return the HTTP password sent with this request, if any. |
| Method | getClient | Get the client's IP address, if it has one. No attempt is made to resolve the address to a hostname. |
| Method | connectionLost | There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore. |
| Method | loseConnection | Pass the loseConnection through to the underlying channel. |
| Instance Variable | _disconnected | A flag which is False until the connection over which this
request was received is closed and which is True after that. (type: bool) |
| Method | _cleanup | Called when have finished responding and are no longer queued. |
| Method | _authorize | Undocumented |
twisted.internet.interfaces.IReactorTCP)
| Parameters | channel | the channel we're connected to. |
| queued | (deprecated) are we in the request queue, or can we start writing to the transport? |
Override in subclasses.
This method is not intended for users.