summaryrefslogtreecommitdiff
path: root/ref
diff options
context:
space:
mode:
authorjcgregorio <devnull@localhost>2007-07-30 14:13:37 +0000
committerjcgregorio <devnull@localhost>2007-07-30 14:13:37 +0000
commit14644379ed993cbef5d2761d1b6b118882df977e (patch)
tree7618e7a5e9e612cc1857315d0b0b1ced4597785d /ref
parentf951105bb98a6a7a7c24c53ea6a00dd70bf4b7af (diff)
downloadhttplib2-14644379ed993cbef5d2761d1b6b118882df977e.tar.gz
Added connection_type argument to Http.request() per Simon Willison request
Diffstat (limited to 'ref')
-rw-r--r--ref/http-objects.html6
1 files changed, 5 insertions, 1 deletions
diff --git a/ref/http-objects.html b/ref/http-objects.html
index 4def852..1cd49ad 100644
--- a/ref/http-objects.html
+++ b/ref/http-objects.html
@@ -61,7 +61,7 @@ Http objects have the following methods:
<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-14' xml:id='l2h-14' class="method">request</tt></b>(</nobr></td>
- <td><var>uri, </var><big>[</big><var>method="GET", body=None, headers=None, redirections=DEFAULT_MAX_REDIRECTS</var><big>]</big><var></var>)</td></tr></table></dt>
+ <td><var>uri, </var><big>[</big><var>method="GET", body=None, headers=None, redirections=DEFAULT_MAX_REDIRECTS, connection_type=None</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Performs a single HTTP request.
The <var>uri</var> is the URI of the HTTP resource and can begin with either <code>http</code> or <code>https</code>. The value of <var>uri</var> must be an absolute URI.
@@ -82,6 +82,10 @@ Any extra headers that are to be sent with the request should be provided in the
The maximum number of redirect to follow before raising an exception is <var>redirections</var>. The default is 5.
<p>
+The <var>connection_type</var> is the type of connection object to use. The supplied class
+should implement the interface of httplib.HTTPConnection.
+
+<p>
The return value is a tuple of (response, content), the first being and instance of the
<tt class="class">Response</tt> class, the second being a string that contains the response entity body.
</dl>