Package twisted :: Package web :: Module server :: Class Request

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

## Class Request

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

Known Subclasses:
  `Request`

Method Summary
| `__init__(self, *args, **kw)`
| ``__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.
| ``connectionLost`(self, reason)` connection was lost
| ``finish`(self)` We are finished writing data.
| ``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)`
| `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)`
| ``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)`
| ``parseCookies`(self)` Parse cookie headers. (inherited from `Request`)
| `pathRef(self)`
| `prePathURL(self)`
| ``process`(self)` Process a request.
| `processingFailed(self, reason)`
| ``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. (inherited from `Request`)
| ``removeComponent`(self, component)` Remove the given component from me entirely, for all interfaces which it has been registered. (inherited from `Componentized`)
| `render(self, resrc)`
| ``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`)
| ``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`)
| ``sibLink`(self, name)` Return the text that links to a sibling of the requested resource.
| ``unregisterProducer`(self)` Unregister the producer. (inherited from `Request`)
| ``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.
| ``view_finish`(self, issuer)` Remote version of finish; same interface.
| ``view_registerProducer`(self, issuer, producer, streaming)` Remote version of registerProducer; same interface.
| ``view_setETag`(self, issuer, tag)` Remote version of setETag; same interface.
| ``view_setHeader`(self, issuer, k, v)` Remote version of setHeader; same interface.
| ``view_setLastModified`(self, issuer, when)` Remote version of setLastModified; same interface.
| ``view_setResponseCode`(self, issuer, code)` Remote version of setResponseCode; same interface.
| `view_unregisterProducer(self, issuer)`
| ``view_write`(self, issuer, data)` Remote version of write; same interface.
| ``write`(self, data)` Write some data as a result of an HTTP request. (inherited from `Request`)

Class Variable Summary
`str` | `__pychecker__`
`NoneType` | `session`
`NoneType` | `site`

Method Details

### childLink(self, name)

Return the text that links to a child of the requested resource.

### connectionLost(self, reason)

connection was lost

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

### finish(self)

We are finished writing data.

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

### process(self)

Process a request.

### sibLink(self, name)

Return the text that links to a sibling of the requested resource.

### view_addCookie(self, issuer, k, v, **kwargs)

Remote version of addCookie; same interface.

### view_finish(self, issuer)

Remote version of finish; same interface.

### view_registerProducer(self, issuer, producer, streaming)

Remote version of registerProducer; same interface. (requires a remote producer.)

### view_setETag(self, issuer, tag)

Remote version of setETag; same interface.

### view_setHeader(self, issuer, k, v)

Remote version of setHeader; same interface.

### view_setLastModified(self, issuer, when)

Remote version of setLastModified; same interface.

### view_setResponseCode(self, issuer, code)

Remote version of setResponseCode; same interface.

### view_write(self, issuer, data)

Remote version of write; same interface.

Class Variable Details

### __pychecker__

  Type:
    `str`
  Value:

        'unusednames=issuer'

### session

  Type:
    `NoneType`
  Value:

        None

### site

  Type:
    `NoneType`
  Value:

        None

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