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

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

Known subclasses: twisted.web.distrib.Request

No class docstring

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
89 Method __init__
94 Method getStateToCopyFor Gather state to send when I am serialized for a particular
114 Method sibLink Return the text that links to a sibling of the requested resource.
121 Method childLink Return the text that links to a child of the requested resource.
134 Method process Process a request.
155 Method render Undocumented
227 Method processingFailed Undocumented
245 Method notifyFinish Notify when finishing the request
256 Method connectionLost connection was lost
261 Method finish We are finished writing data.
267 Method view_write Remote version of write; same interface.
272 Method view_finish Remote version of finish; same interface.
277 Method view_addCookie Remote version of addCookie; same interface.
282 Method view_setHeader Remote version of setHeader; same interface.
287 Method view_setLastModified Remote version of setLastModified; same interface.
292 Method view_setETag Remote version of setETag; same interface.
297 Method view_setResponseCode Remote version of setResponseCode; same interface.
302 Method view_registerProducer Remote version of registerProducer; same interface.
308 Method view_unregisterProducer Undocumented
315 Method getSession Undocumented
350 Method prePathURL Undocumented
353 Method URLPath Undocumented
357 Method rememberRootURL Remember the currently-processed part of the URL for later
365 Method getRootURL Get a previously-remembered URL.
334 Method _prePathURL Undocumented

Inherited from Copyable:

Line # Kind Name Docs
251 Method getStateToCopy Gather state to send when I am serialized for a peer.
271 Method getTypeToCopy Determine what type tag to send for me.
281 Method getTypeToCopyFor Determine what type tag to send for me.
290 Method jellyFor Assemble type tag and state to copy for this broker.

Inherited from Serializable (via Copyable):

Line # Kind Name Docs
79 Method processUniqueID Return an ID which uniquely represents this object for this process.

Inherited from Jellyable (via Copyable, Serializable):

Line # Kind Name Docs
324 Method getStateFor Undocumented

Inherited from Request:

Line # Kind Name Docs
541 Method __setattr__ Support assignment of dict instances to received_headers for
581 Method noLongerQueued Notify the object that it is no longer queued.
607 Method gotLength Called when HTTP channel got length of content in this request.
623 Method parseCookies Parse cookie headers.
645 Method handleContentChunk Write a chunk of data.
653 Method requestReceived Called by channel when all data has been received.
717 Method __repr__ Undocumented
730 Method registerProducer Register a producer.
743 Method unregisterProducer Unregister the producer.
757 Method getHeader Get an HTTP request header.
773 Method getCookie Get a cookie that was sent from the network.
801 Method write Write some data as a result of an HTTP request. The first
864 Method addCookie Set an outgoing HTTP cookie.
886 Method setResponseCode Set the HTTP response code.
898 Method setHeader Set an HTTP response header. Overrides any previously set values for
912 Method redirect Utility function that does a redirect.
921 Method setLastModified Set the Last-Modified time for the response to this request.
954 Method setETag Set an entity tag for the outgoing response.
987 Method getAllHeaders Return dictionary mapping the names of all received headers to the last
1001 Method getRequestHostname Get the hostname that the user passed in to the request.
1019 Method getHost Get my originally requesting transport's host.
1028 Method setHost Change the host and port the request thinks it's using.
1055 Method getClientIP Return the IP address of the client who submitted this request.
1067 Method isSecure Return True if this request is using a secure transport.
1105 Method getUser Return the HTTP user sent with this request, if any.
1121 Method getPassword Return the HTTP password sent with this request, if any.
1137 Method getClient Undocumented
565 Method _cleanup Called when have finished responding and are no longer queued.
751 Method _sendError Undocumented
1087 Method _authorize Undocumented

Inherited from Componentized:

Line # Kind Name Docs
209 Method locateAdapterClass Undocumented
212 Method setAdapter Undocumented
215 Method addAdapter Utility method that calls addComponent. I take an adapter class and
225 Method setComponent Undocumented
230 Method addComponent Add a component to me, for all appropriate interfaces.
252 Method unsetComponent Remove my component specified by the given interface class.
256 Method removeComponent Remove the given component from me entirely, for all interfaces for which
270 Method getComponent Create or retrieve an adapter for the given interface.
303 Method __conform__ Undocumented

Inherited from Versioned (via Componentized):

Line # Kind Name Docs
187 Method __setstate__ Undocumented
191 Method __getstate__ Get state, adding a version number to it on its way out.
207 Method versionUpgrade (internal) Do a version upgrade.
Line # Kind Name Docs
303 Method __conform__ Undocumented
191 Method __getstate__ Get state, adding a version number to it on its way out.
89 Method __init__
717 Method __repr__ Undocumented
541 Method __setattr__ Support assignment of dict instances to received_headers for
187 Method __setstate__ Undocumented
215 Method addAdapter Utility method that calls addComponent. I take an adapter class and
230 Method addComponent Add a component to me, for all appropriate interfaces.
864 Method addCookie Set an outgoing HTTP cookie.
121 Method childLink Return the text that links to a child of the requested resource.
256 Method connectionLost connection was lost
261 Method finish We are finished writing data.
987 Method getAllHeaders Return dictionary mapping the names of all received headers to the last
1137 Method getClient Undocumented
1055 Method getClientIP Return the IP address of the client who submitted this request.
270 Method getComponent Create or retrieve an adapter for the given interface.
773 Method getCookie Get a cookie that was sent from the network.
757 Method getHeader Get an HTTP request header.
1019 Method getHost Get my originally requesting transport's host.
1121 Method getPassword Return the HTTP password sent with this request, if any.
1001 Method getRequestHostname Get the hostname that the user passed in to the request.
365 Method getRootURL Get a previously-remembered URL.
315 Method getSession Undocumented
324 Method getStateFor Undocumented
251 Method getStateToCopy Gather state to send when I am serialized for a peer.
94 Method getStateToCopyFor Gather state to send when I am serialized for a particular
271 Method getTypeToCopy Determine what type tag to send for me.
281 Method getTypeToCopyFor Determine what type tag to send for me.
1105 Method getUser Return the HTTP user sent with this request, if any.
607 Method gotLength Called when HTTP channel got length of content in this request.
645 Method handleContentChunk Write a chunk of data.
1067 Method isSecure Return True if this request is using a secure transport.
290 Method jellyFor Assemble type tag and state to copy for this broker.
209 Method locateAdapterClass Undocumented
581 Method noLongerQueued Notify the object that it is no longer queued.
245 Method notifyFinish Notify when finishing the request
623 Method parseCookies Parse cookie headers.
350 Method prePathURL Undocumented
134 Method process Process a request.
227 Method processingFailed Undocumented
79 Method processUniqueID Return an ID which uniquely represents this object for this process.
912 Method redirect Utility function that does a redirect.
730 Method registerProducer Register a producer.
357 Method rememberRootURL Remember the currently-processed part of the URL for later
256 Method removeComponent Remove the given component from me entirely, for all interfaces for which
155 Method render Undocumented
653 Method requestReceived Called by channel when all data has been received.
212 Method setAdapter Undocumented
225 Method setComponent Undocumented
954 Method setETag Set an entity tag for the outgoing response.
898 Method setHeader Set an HTTP response header. Overrides any previously set values for
1028 Method setHost Change the host and port the request thinks it's using.
921 Method setLastModified Set the Last-Modified time for the response to this request.
886 Method setResponseCode Set the HTTP response code.
114 Method sibLink Return the text that links to a sibling of the requested resource.
743 Method unregisterProducer Unregister the producer.
252 Method unsetComponent Remove my component specified by the given interface class.
353 Method URLPath Undocumented
207 Method versionUpgrade (internal) Do a version upgrade.
277 Method view_addCookie Remote version of addCookie; same interface.
272 Method view_finish Remote version of finish; same interface.
302 Method view_registerProducer Remote version of registerProducer; same interface.
292 Method view_setETag Remote version of setETag; same interface.
282 Method view_setHeader Remote version of setHeader; same interface.
287 Method view_setLastModified Remote version of setLastModified; same interface.
297 Method view_setResponseCode Remote version of setResponseCode; same interface.
308 Method view_unregisterProducer Undocumented
267 Method view_write Remote version of write; same interface.
801 Method write Write some data as a result of an HTTP request. The first
1087 Method _authorize Undocumented
565 Method _cleanup Called when have finished responding and are no longer queued.
334 Method _prePathURL Undocumented
751 Method _sendError Undocumented
def __init__(self, *args, **kw): (source)
overrides twisted.web.http.Request.__init__
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)
overrides twisted.spread.flavors.Copyable.getStateToCopyFor

Gather state to send when I am serialized for a particular perspective.

I will default to calling getStateToCopy. Override this to customize this behavior.
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)
overrides twisted.web.http.Request.process
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)
overrides twisted.web.http.Request.connectionLost
connection was lost
def finish(self): (source)
overrides twisted.web.http.Request.finish
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 2008-10-26 16:12:37.