Package wsgiwapi :: Package cpwsgiserver :: Class HTTPRequest
[frames] | no frames]

Class HTTPRequest

source code

object --+
         |
        HTTPRequest

An HTTP Request (and response).

A single HTTP connection may consist of multiple request/response pairs.

send: the 'send' method from the connection's socket object.
wsgi_app: the WSGI application to call.
environ: a partial WSGI environ (server and connection entries).
    The caller MUST set the following entries:
    * All wsgi.* entries, including .input
    * SERVER_NAME and SERVER_PORT
    * Any SSL_* entries
    * Any custom entries like REMOTE_ADDR and REMOTE_PORT
    * SERVER_SOFTWARE: the value to write in the "Server" response header.
    * ACTUAL_SERVER_PROTOCOL: the value to write in the Status-Line of
        the response. From RFC 2145: "An HTTP server SHOULD send a
        response version equal to the highest version for which the
        server is at least conditionally compliant, and whose major
        version is less than or equal to the one received in the
        request.  An HTTP server MUST NOT send a version for which
        it is not at least conditionally compliant."

outheaders: a list of header tuples to write in the response.
ready: when True, the request has been parsed and is ready to begin
    generating the response. When False, signals the calling Connection
    that the response should not be generated and the connection should
    close.
close_connection: signals the calling Connection that the request
    should close. This does not imply an error! The client and/or
    server may each request that the connection be closed.
chunked_write: if True, output will be encoded with the "chunked"
    transfer-coding. This value is set automatically inside
    send_headers.

Instance Methods
 
__init__(self, wfile, environ, wsgi_app)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
parse_request(self)
Parse the next HTTP request start-line and message-headers.
source code
 
read_headers(self)
Read header lines from the incoming stream.
source code
 
decode_chunked(self)
Decode the 'chunked' transfer coding.
source code
 
respond(self)
Call the appropriate WSGI app and write its iterable output.
source code
 
simple_response(self, status, msg="")
Write a simple response back to the client.
source code
 
start_response(self, status, headers, exc_info=None)
WSGI callable to begin the HTTP response.
source code
 
write(self, chunk)
WSGI callable to write unbuffered data to the client.
source code
 
send_headers(self)
Assert, process, and send the HTTP response message-headers.
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables
  max_request_header_size = 0
  max_request_body_size = 0
Properties

Inherited from object: __class__

Method Details

__init__(self, wfile, environ, wsgi_app)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

write(self, chunk)

source code 

WSGI callable to write unbuffered data to the client.

This method is also used internally by start_response (to write data from the iterable returned by the WSGI application).