aboutsummaryrefslogtreecommitdiff
path: root/http.agent-api.html
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2009-08-25 13:00:30 -0700
committerTom Faulhaber <git_net@infolace.com>2009-08-25 13:00:30 -0700
commite46db64700aa5d6df3561d34636e22db65e0215c (patch)
tree07bd4d46d8a487615c85bdbe6e721b8a636d1a43 /http.agent-api.html
parentfb121f1544f7af90dd2058d6395dd7c85f4d54fb (diff)
Updated documentation for commit e456075c7dfc280e3371e9681fd4ff83b4f14896
Diffstat (limited to 'http.agent-api.html')
-rw-r--r--http.agent-api.html42
1 files changed, 21 insertions, 21 deletions
diff --git a/http.agent-api.html b/http.agent-api.html
index 9b01726c..196626c0 100644
--- a/http.agent-api.html
+++ b/http.agent-api.html
@@ -93,7 +93,7 @@ namespace.
</div>
</div></div>
<div id="content-tag"><div><h1 id="overview">API for <span id="namespace-name">http.agent</span></h1>
-by <span id="author">Unknown</span><br />
+by <span id="author">Stuart Sierra</span><br />
<br />Usage:
<pre>
(ns your-namespace
@@ -158,7 +158,7 @@ And you could write the response directly to a file like this:
<pre id="var-docstr">The default HTTP agent result handler; it collects the response
body in a java.io.ByteArrayOutputStream, which can later be
retrieved with the 'stream', 'string', and 'bytes' functions.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L144" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L146" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -168,7 +168,7 @@ retrieved with the 'stream', 'string', and 'bytes' functions.</pre>
</pre>
<pre id="var-docstr">Returns a Java byte array of the content returned by the server;
nil if the content is not yet available.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L250" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L252" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -177,7 +177,7 @@ nil if the content is not yet available.</pre>
<pre id="var-usage">Usage: (client-error? http-agnt)
</pre>
<pre id="var-docstr">Returns true if the HTTP response code was in the 400-499 range.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L360" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L362" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -186,7 +186,7 @@ nil if the content is not yet available.</pre>
<pre id="var-usage">Usage: (done? http-agnt)
</pre>
<pre id="var-docstr">Returns true if the HTTP request/response has completed.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L299" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L301" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -196,7 +196,7 @@ nil if the content is not yet available.</pre>
</pre>
<pre id="var-docstr">Returns true if the HTTP response code was in the 400-499 range OR
the 500-599 range.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L370" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L372" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -207,7 +207,7 @@ the 500-599 range.</pre>
<pre id="var-docstr">Returns a map of HTTP response headers. Header names are converted
to keywords in all lower-case Header values are strings. If a
header appears more than once, only the last value is returned.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L320" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L322" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -218,7 +218,7 @@ header appears more than once, only the last value is returned.</pre>
<pre id="var-docstr">Returns the HTTP response headers in order as a sequence of
[String,String] pairs. The first 'header' name may be null for the
HTTP status line.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L330" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L332" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -274,7 +274,7 @@ exceptions thrown by this function will be added to the agent's
error queue (see agent-errors). The default function collects the
response stream in a memory buffer.
</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L165" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L167" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -284,7 +284,7 @@ response stream in a memory buffer.
</pre>
<pre id="var-docstr">Returns the HTTP response message (e.g. 'Not Found'), for this
request, or nil if the response has not yet been received.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L313" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L315" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -293,7 +293,7 @@ request, or nil if the response has not yet been received.</pre>
<pre id="var-usage">Usage: (method http-agnt)
</pre>
<pre id="var-docstr">Returns the HTTP method name used by this HTTP agent, as a String.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L283" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L285" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -306,7 +306,7 @@ request, or nil if the response has not yet been received.</pre>
Note: if the :follow-redirects option was true (the default),
redirects will be followed automatically and a the agent will never
return a 3xx response code.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L351" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L353" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -318,7 +318,7 @@ return a 3xx response code.</pre>
Note: if the request body was an InputStream or a Reader, it will no
longer be usable.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L288" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L290" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -327,7 +327,7 @@ longer be usable.</pre>
<pre id="var-usage">Usage: (request-headers http-agnt)
</pre>
<pre id="var-docstr">Returns the request headers specified for this HTTP agent.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L278" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L280" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -336,7 +336,7 @@ longer be usable.</pre>
<pre id="var-usage">Usage: (request-uri http-agnt)
</pre>
<pre id="var-docstr">Returns the URI/URL requested by this HTTP agent, as a String.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L273" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L275" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -347,7 +347,7 @@ longer be usable.</pre>
<pre id="var-docstr">Returns the value returned by the :handler function of the HTTP
agent; blocks until the HTTP request is completed. The default
handler function returns a ByteArrayOutputStream.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L228" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L230" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -356,7 +356,7 @@ handler function returns a ByteArrayOutputStream.</pre>
<pre id="var-usage">Usage: (server-error? http-agnt)
</pre>
<pre id="var-docstr">Returns true if the HTTP response code was in the 500-599 range.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L365" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L367" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -367,7 +367,7 @@ handler function returns a ByteArrayOutputStream.</pre>
<pre id="var-docstr">Returns the HTTP response status code (e.g. 200, 404) for this
request, as an Integer, or nil if the status has not yet been
received.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L305" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L307" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -381,7 +381,7 @@ HttpURLConnection stream.
If the default handler function was used, this function returns a
ByteArrayInputStream on the buffered response body.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L236" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L238" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -396,7 +396,7 @@ encoding.
If no encoding is given, uses the encoding specified in the server
headers, or clojure.contrib.duck-streams/*default-encoding* if it is
not specified.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L256" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L258" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
@@ -405,7 +405,7 @@ not specified.</pre>
<pre id="var-usage">Usage: (success? http-agnt)
</pre>
<pre id="var-docstr">Returns true if the HTTP response code was in the 200-299 range.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/1e0d828a9b7ff1a4cbc19365c7df5663419631e9/src/clojure/contrib/http/agent.clj#L346" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/e456075c7dfc280e3371e9681fd4ff83b4f14896/src/clojure/contrib/http/agent.clj#L348" id="var-source">Source</a>
</div>