Package twisted :: Package web :: Module distrib :: Class Request

[show private | hide private]
[frames | no frames]

## Class Request

          Unjellyable --+
                        |
               RemoteCopy --+
                            |
    Jellyable --+           |
                |           |
     Serializable --+       |
                    |       |
             Copyable --+   |
                        |   |
              Request --+   |
                        |   |
        Versioned --+   |   |
                    |   |   |
        Componentized --+   |
                        |   |
                  Request --+
                            |
                           Request

Method Summary
| `__init__(self, *args, **kw)` (inherited from `Request`)
| ``__getstate__`(self, dict)` Get state, adding a version number to it on its way out. (inherited from `Versioned`)
| `__repr__(self)` (inherited from `Request`)
| `__setstate__(self, state)` (inherited from `Versioned`)
| ``addAdapter`(self, adapterClass, ignoreClass, registry)` Utility method that calls addComponent. (inherited from `Componentized`)
| ``addComponent`(self, component, ignoreClass, registry)` Add a component to me, for all appropriate interfaces. (inherited from `Componentized`)
| ``addCookie`(self, k, v, expires, domain, path, max_age, comment, secure)` Set an outgoing HTTP cookie. (inherited from `Request`)
| ``childLink`(self, name)` Return the text that links to a child of the requested resource. (inherited from `Request`)
| ``connectionLost`(self, reason)` connection was lost (inherited from `Request`)
| `fail(self, failure)`
| ``finish`(self)` We are finished writing data. (inherited from `Request`)
| ``getAllHeaders`(self)` Return dictionary of all headers the request received. (inherited from `Request`)
| `getClient(self)` (inherited from `Request`)
| `getClientIP(self)` (inherited from `Request`)
| ``getComponent`(self, interface, registry, default)` Create or retrieve an adapter for the given interface. (inherited from `Componentized`)
| ``getCookie`(self, key)` Get a cookie that was sent from the network. (inherited from `Request`)
| ``getHeader`(self, key)` Get a header that was sent from the network. (inherited from `Request`)
| ``getHost`(self)` Get my originally requesting transport's host. (inherited from `Request`)
| `getPassword(self)` (inherited from `Request`)
| ``getRequestHostname`(self)` Get the hostname that the user passed in to the request. (inherited from `Request`)
| `getSession(self, sessionInterface)` (inherited from `Request`)
| `getStateFor(self, jellier)` (inherited from `Jellyable`)
| ``getStateToCopy`(self)` Gather state to send when I am serialized for a peer. (inherited from `Copyable`)
| `getStateToCopyFor(self, issuer)` (inherited from `Request`)
| ``getTypeToCopy`(self)` Determine what type tag to send for me. (inherited from `Copyable`)
| ``getTypeToCopyFor`(self, perspective)` Determine what type tag to send for me. (inherited from `Copyable`)
| `getUser(self)` (inherited from `Request`)
| ``gotLength`(self, length)` Called when HTTP channel got length of content in this request. (inherited from `Request`)
| ``handleContentChunk`(self, data)` Write a chunk of data. (inherited from `Request`)
| `isSecure(self)` (inherited from `Request`)
| ``jellyFor`(self, jellier)` Assemble type tag and state to copy for this broker. (inherited from `Copyable`)
| `locateAdapterClass(self, klass, interfaceClass, default, registry)` (inherited from `Componentized`)
| ``noLongerQueued`(self)` Notify the object that it is no longer queued. (inherited from `Request`)
| `notifyFinish(self)` (inherited from `Request`)
| ``parseCookies`(self)` Parse cookie headers. (inherited from `Request`)
| `pathRef(self)` (inherited from `Request`)
| `prePathURL(self)` (inherited from `Request`)
| ``process`(self)` Process a request. (inherited from `Request`)
| `processingFailed(self, reason)` (inherited from `Request`)
| ``processUniqueID`(self)` Return an ID which uniquely represents this object for this process. (inherited from `Serializable`)
| ``redirect`(self, url)` Utility function that does a redirect. (inherited from `Request`)
| ``registerProducer`(self, producer, streaming)` Register a producer.
| ``removeComponent`(self, component)` Remove the given component from me entirely, for all interfaces which it has been registered. (inherited from `Componentized`)
| `render(self, resrc)` (inherited from `Request`)
| ``requestReceived`(self, command, path, version)` Called by channel when all data has been received. (inherited from `Request`)
| `setAdapter(self, interfaceClass, adapterClass)` (inherited from `Componentized`)
| `setComponent(self, interfaceClass, component)` (inherited from `Componentized`)
| ``setCopyableState`(self, state)` I will be invoked with the state to copy locally.
| ``setETag`(self, etag)` Set an entity tagfor the outgoing response. (inherited from `Request`)
| ``setHeader`(self, k, v)` Set an outgoing HTTP header. (inherited from `Request`)
| ``setHost`(self, host, port, ssl)` Change the host and port the request thinks it's using. (inherited from `Request`)
| ``setLastModified`(self, when)` Set the Last-Modifiedtime for the response to this request. (inherited from `Request`)
| ``setResponseCode`(self, code, message)` Set the HTTP response code. (inherited from `Request`)
| `setStateFor(self, unjellier, state)` (inherited from `Unjellyable`)
| ``sibLink`(self, name)` Return the text that links to a sibling of the requested resource. (inherited from `Request`)
| `unjellyFor(self, unjellier, jellyList)` (inherited from `RemoteCopy`)
| ``unregisterProducer`(self)` Unregister the producer.
| ``unsetComponent`(self, interfaceClass)` Remove my component specified by the given interface class. (inherited from `Componentized`)
| `upgradeToVersion1(self)` (inherited from `Componentized`)
| ``versionUpgrade`(self)` (internal) Do a version upgrade. (inherited from `Versioned`)
| ``view_addCookie`(self, issuer, k, v, **kwargs)` Remote version of addCookie; same interface. (inherited from `Request`)
| ``view_finish`(self, issuer)` Remote version of finish; same interface. (inherited from `Request`)
| ``view_registerProducer`(self, issuer, producer, streaming)` Remote version of registerProducer; same interface. (inherited from `Request`)
| ``view_setETag`(self, issuer, tag)` Remote version of setETag; same interface. (inherited from `Request`)
| ``view_setHeader`(self, issuer, k, v)` Remote version of setHeader; same interface. (inherited from `Request`)
| ``view_setLastModified`(self, issuer, when)` Remote version of setLastModified; same interface. (inherited from `Request`)
| ``view_setResponseCode`(self, issuer, code)` Remote version of setResponseCode; same interface. (inherited from `Request`)
| `view_unregisterProducer(self, issuer)` (inherited from `Request`)
| ``view_write`(self, issuer, data)` Remote version of write; same interface. (inherited from `Request`)
| ``write`(self, data)` Write some data as a result of an HTTP request. (inherited from `Request`)
| `_authorize(self)` (inherited from `Request`)
| ``_cleanup`(self)` Called when have finished responding and are no longer queued. (inherited from `Request`)
| `_sendError(self, code, resp)` (inherited from `Request`)

Method Details

### registerProducer(self, producer, streaming)

Register a producer.

  Overrides:
    `twisted.protocols.http.Request.registerProducer` (inherited documentation)

### setCopyableState(self, state)

I will be invoked with the state to copy locally.

'state' is the data returned from the remote object's 'getStateToCopyFor' method, which will often be the remote object's dictionary (or a filtered approximation of it depending on my peer's perspective).

  Overrides:
    `twisted.spread.flavors.RemoteCopy.setCopyableState` (inherited documentation)

### unregisterProducer(self)

Unregister the producer.

  Overrides:
    `twisted.protocols.http.Request.unregisterProducer` (inherited documentation)

Generated by Epydoc 1.1 on Thu May 8 13:19:06 2003 | http://epydoc.sf.net