Public Member Functions | Public Attributes
tornado.httpclient.HTTPRequest Class Reference

List of all members.

Public Member Functions

def __init__

Public Attributes

 allow_ipv6
 allow_nonstandard_methods
 auth_password
 auth_username
 body
 ca_certs
 client_cert
 client_key
 connect_timeout
 follow_redirects
 header_callback
 headers
 max_redirects
 method
 network_interface
 prepare_curl_callback
 proxy_host
 proxy_password
 proxy_port
 proxy_username
 request_timeout
 start_time
 streaming_callback
 url
 use_gzip
 user_agent
 validate_cert

Detailed Description

HTTP client request object.

Definition at line 225 of file httpclient.py.


Constructor & Destructor Documentation

def tornado.httpclient.HTTPRequest.__init__ (   self,
  url,
  method = "GET",
  headers = None,
  body = None,
  auth_username = None,
  auth_password = None,
  connect_timeout = 20.0,
  request_timeout = 20.0,
  if_modified_since = None,
  follow_redirects = True,
  max_redirects = 5,
  user_agent = None,
  use_gzip = True,
  network_interface = None,
  streaming_callback = None,
  header_callback = None,
  prepare_curl_callback = None,
  proxy_host = None,
  proxy_port = None,
  proxy_username = None,
  proxy_password = '',
  allow_nonstandard_methods = False,
  validate_cert = True,
  ca_certs = None,
  allow_ipv6 = None,
  client_key = None,
  client_cert = None 
)
Creates an `HTTPRequest`.

All parameters except `url` are optional.

:arg string url: URL to fetch
:arg string method: HTTP method, e.g. "GET" or "POST"
:arg headers: Additional HTTP headers to pass on the request
:type headers: `~tornado.httputil.HTTPHeaders` or `dict`
:arg string auth_username: Username for HTTP "Basic" authentication
:arg string auth_password: Password for HTTP "Basic" authentication
:arg float connect_timeout: Timeout for initial connection in seconds
:arg float request_timeout: Timeout for entire request in seconds
:arg datetime if_modified_since: Timestamp for ``If-Modified-Since``
   header
:arg bool follow_redirects: Should redirects be followed automatically
   or return the 3xx response?
:arg int max_redirects: Limit for `follow_redirects`
:arg string user_agent: String to send as ``User-Agent`` header
:arg bool use_gzip: Request gzip encoding from the server
:arg string network_interface: Network interface to use for request
:arg callable streaming_callback: If set, `streaming_callback` will
   be run with each chunk of data as it is received, and
   `~HTTPResponse.body` and `~HTTPResponse.buffer` will be empty in
   the final response.
:arg callable header_callback: If set, `header_callback` will
   be run with each header line as it is received, and
   `~HTTPResponse.headers` will be empty in the final response.
:arg callable prepare_curl_callback: If set, will be called with
   a `pycurl.Curl` object to allow the application to make additional
   `setopt` calls.
:arg string proxy_host: HTTP proxy hostname.  To use proxies,
   `proxy_host` and `proxy_port` must be set; `proxy_username` and
   `proxy_pass` are optional.  Proxies are currently only support
   with `curl_httpclient`.
:arg int proxy_port: HTTP proxy port
:arg string proxy_username: HTTP proxy username
:arg string proxy_password: HTTP proxy password
:arg bool allow_nonstandard_methods: Allow unknown values for `method`
   argument?
:arg bool validate_cert: For HTTPS requests, validate the server's
   certificate?
:arg string ca_certs: filename of CA certificates in PEM format,
   or None to use defaults.  Note that in `curl_httpclient`, if
   any request uses a custom `ca_certs` file, they all must (they
   don't have to all use the same `ca_certs`, but it's not possible
   to mix requests with ca_certs and requests that use the defaults.
:arg bool allow_ipv6: Use IPv6 when available?  Default is false in
   `simple_httpclient` and true in `curl_httpclient`
:arg string client_key: Filename for client SSL key, if any
:arg string client_cert: Filename for client SSL certificate, if any

Definition at line 227 of file httpclient.py.


Member Data Documentation

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.

Definition at line 277 of file httpclient.py.


The documentation for this class was generated from the following file:


roswww
Author(s): Jonathan Mace
autogenerated on Thu Jan 2 2014 11:53:30