class documentation
class ConsumerDummyHandler(http.Request): (source)
Known subclasses: twisted.web.test.test_http2.AbortingConsumerDummyHandler
This is a HTTP request handler that works with the IPushProducer implementation in the H2Stream
object. No current IRequest object does that, but in principle future implementations could: that codepath should therefore be tested.
Method | __init__ |
No summary |
Method | accept |
Start the data pipe. |
Method | process |
Override in subclasses. |
Method | request |
Called by channel when all data has been received. |
Instance Variable | _data |
Undocumented |
Instance Variable | _request |
Undocumented |
Inherited from Request
:
Method | __eq__ |
Determines if two requests are the same object. |
Method | __hash__ |
A Request is hashable so that it can be used as a mapping key. |
Method | __repr__ |
Return a string description of the request including such information as the request method and request URI. |
Method | add |
Set an outgoing HTTP cookie. |
Method | connection |
There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore. |
Method | finish |
Indicate that all response data has been written to this Request . |
Method | get |
Return dictionary mapping the names of all received headers to the last value received for each. |
Method | get |
Return the address of the client who submitted this request. |
Method | get |
Return the IP address of the client who submitted this request. |
Method | get |
Get a cookie that was sent from the network. |
Method | get |
Get an HTTP request header. |
Method | get |
Get my originally requesting transport's host. |
Method | get |
Return the HTTP password sent with this request, if any. |
Method | get |
Get the hostname that the HTTP client passed in to the request. |
Method | get |
Return the HTTP user sent with this request, if any. |
Method | got |
Called when HTTP channel got length of content in this request. |
Method | handle |
Write a chunk of data. |
Method | is |
Return True if this request is using a secure transport. |
Method | lose |
Pass the loseConnection through to the underlying channel. |
Method | no |
Notify the object that it is no longer queued. |
Method | notify |
Notify when the response to this request has finished. |
Method | parse |
Parse cookie headers. |
Method | redirect |
Utility function that does a redirect. |
Method | register |
Register a producer. |
Method | set |
Set an entity tag for the outgoing response. |
Method | set |
Set an HTTP response header. Overrides any previously set values for this header. |
Method | set |
Change the host and port the request thinks it's using. |
Method | set |
Set the Last-Modified time for the response to this request. |
Method | set |
Set the HTTP response code. |
Method | unregister |
Unregister the producer. |
Method | write |
Write some data as a result of an HTTP request. The first time this is called, it writes out response data. |
Instance Variable | args |
A mapping of decoded query argument names as bytes to corresponding query argument values as list s of bytes . For example, for a URI with foo=bar&foo=baz&quux=spam as its query part args will be {b'foo': [b'bar', b'baz'], b'quux': [b'spam']}... |
Instance Variable | channel |
Undocumented |
Instance Variable | chunked |
Undocumented |
Instance Variable | client |
Undocumented |
Instance Variable | clientproto |
Undocumented |
Instance Variable | code |
Undocumented |
Instance Variable | code |
Undocumented |
Instance Variable | content |
A file-like object giving the request body. This may be a file on disk, an io.BytesIO , or some other type. The implementation is free to decide on a per-request basis. |
Instance Variable | cookies |
The cookies that will be sent in the response. |
Instance Variable | etag |
Undocumented |
Instance Variable | finished |
Undocumented |
Instance Variable | host |
Undocumented |
Instance Variable | last |
Undocumented |
Instance Variable | method |
The HTTP method that was used, e.g. b'GET'. |
Instance Variable | notifications |
A list of Deferred s which are waiting for notification that the response to this request has been finished (successfully or with an error). Don't use this attribute directly, instead use the Request.notifyFinish ... |
Instance Variable | password |
Undocumented |
Instance Variable | path |
The encoded path of the request URI (not including query arguments), e.g. b'/a/b%20/c'. |
Instance Variable | producer |
Undocumented |
Instance Variable | queued |
Undocumented |
Instance Variable | received |
Undocumented |
Instance Variable | request |
All received HTTP request headers. |
Instance Variable | response |
All HTTP response headers to be sent. |
Instance Variable | sent |
Undocumented |
Instance Variable | started |
Undocumented |
Instance Variable | streaming |
Undocumented |
Instance Variable | transport |
Undocumented |
Instance Variable | uri |
The full encoded URI which was requested (including query arguments), e.g. b'/a/b%20/c?q=v'. |
Instance Variable | user |
Undocumented |
Method | _authorize |
Undocumented |
Method | _cleanup |
Called when have finished responding and are no longer queued. |
Instance Variable | _disconnected |
A flag which is False until the connection over which this request was received is closed and which is True after that. |
Instance Variable | _force |
Undocumented |
Instance Variable | _log |
A logger instance for request related messages. |
overrides
twisted.web.http.Request.__init__
Parameters | |
*args | Undocumented |
**kwargs | Undocumented |
channel | the channel we're connected to. |
queued | (deprecated) are we in the request queue, or can we start writing to the transport? |
overrides
twisted.web.http.Request.process
Override in subclasses.
This method is not intended for users.
overrides
twisted.web.http.Request.requestReceived
Called by channel when all data has been received.
This method is not intended for users.
Parameters | |
*args | Undocumented |
**kwargs | Undocumented |
command:bytes | The HTTP verb of this request. This has the case supplied by the client (eg, it maybe "get" rather than "GET"). |
path:bytes | The URI of this request. |
version:bytes | The HTTP version of this request. |