t.w.s.Request(pb.Copyable, http.Request, components.Componentized) : class documentation

Part of twisted.web.server View Source View In Hierarchy

Known subclasses: twisted.web.distrib.Request

No class docstring
Method __init__
Method getStateToCopyFor 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 process Process a request.
Method render Undocumented
Method processingFailed Undocumented
Method notifyFinish Notify when finishing the request
Method connectionLost connection was lost
Method finish We are finished writing data.
Method view_write Remote version of write; same interface.
Method view_finish Remote version of finish; same interface.
Method view_addCookie Remote version of addCookie; same interface.
Method view_setHeader Remote version of setHeader; same interface.
Method view_setLastModified Remote version of setLastModified; same interface.
Method view_setETag Remote version of setETag; same interface.
Method view_setResponseCode Remote version of setResponseCode; same interface.
Method view_registerProducer Remote version of registerProducer; same interface. (requires a remote producer.)
Method view_unregisterProducer Undocumented
Method getSession Undocumented
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 _prePathURL Undocumented

Inherited from Request:

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__ Undocumented
Method registerProducer Register a producer.
Method unregisterProducer Unregister the producer.
Method getHeader Get a header that was sent from the network.
Method getCookie Get a cookie that was sent from the network.
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 outgoing HTTP 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 of all headers the request received.
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 Undocumented
Method _cleanup Called when have finished responding and are no longer queued.
Method _sendError Undocumented
Method _authorize 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.
def __init__(self, *args, **kw): (source)
Parameterschannelthe channel we're connected to.
queuedare we in the request queue, or can we start writing to the transport?
def getStateToCopyFor(self, issuer): (source)
Undocumented
def sibLink(self, name): (source)
Return the text that links to a sibling of the requested resource.
def childLink(self, name): (source)
Return the text that links to a child of the requested resource.
def process(self): (source)
Process a request.
def render(self, resrc): (source)
Undocumented
def processingFailed(self, reason): (source)
Undocumented
def notifyFinish(self): (source)
Notify when finishing the request
ReturnsA deferred. The deferred will be triggered when the request is finished -- with a None value if the request finishes successfully or with an error if the request is stopped by the client.
def connectionLost(self, reason): (source)
connection was lost
def finish(self): (source)
We are finished writing data.
def view_write(self, issuer, data): (source)
Remote version of write; same interface.
def view_finish(self, issuer): (source)
Remote version of finish; same interface.
def view_addCookie(self, issuer, k, v, **kwargs): (source)
Remote version of addCookie; same interface.
def view_setHeader(self, issuer, k, v): (source)
Remote version of setHeader; same interface.
def view_setLastModified(self, issuer, when): (source)
Remote version of setLastModified; same interface.
def view_setETag(self, issuer, tag): (source)
Remote version of setETag; same interface.
def view_setResponseCode(self, issuer, code): (source)
Remote version of setResponseCode; same interface.
def view_registerProducer(self, issuer, producer, streaming): (source)
Remote version of registerProducer; same interface. (requires a remote producer.)
def view_unregisterProducer(self, issuer): (source)
Undocumented
def getSession(self, sessionInterface=None): (source)
Undocumented
def _prePathURL(self, prepath): (source)
Undocumented
def prePathURL(self): (source)
Undocumented
def URLPath(self): (source)
Undocumented
def rememberRootURL(self): (source)
Remember the currently-processed part of the URL for later recalling.
def getRootURL(self): (source)
Get a previously-remembered URL.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.