Part of twisted.web2.compat View Source View In Hierarchy
Implements interfaces: twisted.web2.iweb.IOldRequest
Method | __init__ | Undocumented |
Method | getStateToCopyFor | Gather state to send when I am serialized for a particular perspective. |
Method | getTypeToCopy | Determine what type tag to send for me. |
Method | registerProducer | Undocumented |
Method | unregisterProducer | Undocumented |
Method | finish | We are finished writing data. |
Method | write | Write some data as a result of an HTTP request. The first time this is called, it writes out response data. |
Method | getHeader | Get a header that was sent from the network. |
Method | setHeader | Set an outgoing HTTP header. |
Method | setResponseCode | Set the HTTP response code. |
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 of all headers the request received. |
Method | getRequestHostname | Get the hostname that the user passed in to the request. |
Method | getCookie | Get a cookie that was sent from the network. |
Method | addCookie | Set an outgoing HTTP cookie. |
Method | notifyFinish | Undocumented |
Method | getHost | Get my originally requesting transport's host. |
Method | setHost | Change the host and port the request thinks it's using. |
Method | isSecure | Undocumented |
Method | getClientIP | Undocumented |
Method | getClient | Undocumented |
Method | getUser | Undocumented |
Method | getPassword | Undocumented |
Method | sibLink | Return the text that links to a sibling of the requested resource. |
Method | childLink | Return the text that links to a child of the requested resource. |
Method | redirect | Utility function that does a redirect. |
Method | prePathURL | Undocumented |
Method | URLPath | Undocumented |
Method | rememberRootURL | Remember the currently-processed part of the URL for later recalling. |
Method | getRootURL | Get a previously-remembered URL. |
Method | getSession | Undocumented |
Method | _getFrom | Undocumented |
Method | _getsetFrom | Undocumented |
Method | _getsetHeaders | Undocumented |
Method | _getClientproto | Undocumented |
Method | _getClient | Undocumented |
Method | _getHost | Undocumented |
Inherited from Copyable:
Method | getStateToCopy | Gather state to send when I am serialized for a peer. |
Method | getTypeToCopyFor | Determine what type tag to send for me. |
Method | jellyFor | Assemble type tag and state to copy for this broker. |
Inherited from Serializable (via Copyable):
Method | processUniqueID | Return an ID which uniquely represents this object for this process. |
Inherited from Jellyable (via Copyable, Serializable):
Method | getStateFor | Undocumented |
Inherited from Componentized:
Method | locateAdapterClass | Undocumented |
Method | setAdapter | Undocumented |
Method | addAdapter | Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument. |
Method | setComponent | Undocumented |
Method | addComponent | Add a component to me, for all appropriate interfaces. |
Method | unsetComponent | Remove my component specified by the given interface class. |
Method | removeComponent | Remove the given component from me entirely, for all interfaces for which it has been registered. |
Method | getComponent | Create or retrieve an adapter for the given interface. |
Method | __conform__ | Undocumented |
Inherited from Versioned (via Componentized):
Method | __setstate__ | Undocumented |
Method | __getstate__ | Get state, adding a version number to it on its way out. |
Method | versionUpgrade | (internal) Do a version upgrade. |
Gather state to send when I am serialized for a particular perspective.
I will default to callinggetStateToCopy
. Override this to
customize this behavior.
Determine what type tag to send for me.
By default, send the string representation of my class (package.module.Class); normally this is adequate, but you may override this to change it.Set the Last-Modified
time for the response to this
request.
If I am called more than once, I ignore attempts to set
Last-Modified
earlier, only replacing the
Last-Modified
time if it is to a later value.
NOT_MODIFIED
if appropriate for the time given.
Parameters | when | The last time the resource being returned was modified, in seconds since the epoch. (type: number ) |
Returns | If I am a If-Modified-Since conditional request and the
time given is not newer than the condition, I return
http.CACHED to indicate that you should write no body.
Otherwise, I return a false value.
|
Set an entity tag
for the outgoing response.
That's "entity tag" as in the HTTP/1.1 ETag
header, "used for comparing two or more entities from the same
requested resource."
NOT_MODIFIED
or PRECONDITION_FAILED
, if
appropriate for the tag given.
Parameters | etag | The entity tag for the resource being returned. (type: string ) |
Returns | If I am a If-None-Match conditional request and the tag
matches one in the request, I return http.CACHED to indicate
that you should write no body. Otherwise, I return a false value.
|
Get the hostname that the user passed in to the request.
This will either use the Host: header (if it is available) or the host we are listening on if the header is unavailable.Set an outgoing HTTP cookie.
In general, you should consider using sessions instead of cookies, seetwisted.web.server.Request.getSession
and the twisted.web.server.Session
class for details.
Get my originally requesting transport's host.
Don't rely on the 'transport' attribute, since Request objects may be copied remotely. For information on this method's return value, seetwisted.internet.tcp.Port
.
Change the host and port the request thinks it's using.
This method is useful for working with reverse HTTP proxies (e.g. both Squid and Apache's mod_proxy can do this), when the address the HTTP client is using is different than the one we're listening on.
For example, Apache may be listening on https://www.example.com, and then forwarding requests to http://localhost:8080, but we don't want HTML produced by Twisted to say 'http://localhost:8080', they should say 'https://www.example.com', so we do:request.setHost('www.example.com', 443, ssl=1)This method is experimental.
Utility function that does a redirect.
The request should have finish() called after this.