summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Faulhaber <git_net@infolace.com>2009-08-14 12:04:34 -0700
committerTom Faulhaber <git_net@infolace.com>2009-08-14 12:04:34 -0700
commit4db08e5db716c513085972df6b06dbccbb77dc83 (patch)
treef5d5c74fbb04b556331257badb7dfd2b3b8b155a
parent23dce7d3dde629910f18c1cfe770f022f4e82bd1 (diff)
Updated documentation for commit 05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a
-rw-r--r--api-index.html1
-rw-r--r--api-index.json25
-rw-r--r--http.agent-api.html24
-rw-r--r--index.html2
4 files changed, 36 insertions, 16 deletions
diff --git a/api-index.html b/api-index.html
index 4a45c498..c8234558 100644
--- a/api-index.html
+++ b/api-index.html
@@ -558,6 +558,7 @@ Shortcuts:<br />
</span></span><span id="section-content"> <a href="http.agent-api.html#response-headers-seq">response-headers-seq</a><span id="line-content"> function http.agent Returns the HTTP response headers in order as a se...
</span></span><span id="section-content"> <a href="http.agent-api.html#response-message">response-message</a><span id="line-content"> function http.agent Returns the HTTP response message (e.g. 'Not Found...
</span></span><span id="section-content"> <a href="http.agent-api.html#response-status">response-status</a><span id="line-content"> function http.agent Returns the Integer response status code (e.g. 200...
+</span></span><span id="section-content"> <a href="http.agent-api.html#response-success?">response-success?</a><span id="line-content"> function http.agent Returns true if the HTTP response code was in the ...
</span></span><span id="section-content"> <a href="graph-api.html#reverse-graph">reverse-graph</a><span id="line-content"> function graph Given a directed graph, return another directed gr...
</span></span><span id="section-content"> <a href="zip-filter-api.html#right-locs">right-locs</a><span id="line-content"> function zip-filter Returns a lazy sequence of locations to the right ...
</span></span><span id="section-content"> <a href="zip-filter-api.html#rightmost?">rightmost?</a><span id="line-content"> function zip-filter Returns true if there are no more nodes to the rig...
diff --git a/api-index.json b/api-index.json
index 7eb95b73..94365c97 100644
--- a/api-index.json
+++ b/api-index.json
@@ -200,7 +200,7 @@
"doc":
"Various functions for finding greatest and least values in a collection"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj",
"wiki-url":
"http://richhickey.github.com/clojure-contrib/http.agent-api.html",
"name":"clojure.contrib.http.agent",
@@ -2259,7 +2259,7 @@
"doc":"Return the argument for which f yields the smallest value.",
"name":"least-by"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L58",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L58",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/http-agent",
"namespace":"clojure.contrib.http.agent",
@@ -2268,7 +2268,7 @@
"Creates (and immediately returns) an Agent representing an HTTP\nrequest running in a new thread.\n\noptions are key/value pairs:\n\n:method string\n\nThe HTTP method name. Default is \"GET\".\n\n:headers h\n\nHTTP headers, as a Map or a sequence of pairs like \n([key1,value1], [key2,value2]) Default is nil.\n\n:body b\n\nHTTP request entity body, one of nil, String, byte[], InputStream,\nReader, or File. Default is nil.\n\n:connect-timeout int\n\nTimeout value, in milliseconds, when opening a connection to the\nURL. Default is zero, meaning no timeout.\n\n:read-timeout int\n\nTimeout value, in milliseconds, when reading data from the\nconnection. Default is zero, meaning no timeout.\n\n:follow-redirects boolean\n\nIf true, HTTP 3xx redirects will be followed automatically. Default\nis true.\n\n:on-success f\n\nFunction to be called when the request succeeds with a 2xx response\ncode. Default is nil, do nothing. The function will be called with\nthe HTTP agent as its argument. Any exceptions thrown by this\nfunction will be added to the agent's error queue (see\nagent-errors).\n\n:on-failure f\n\nFunction to be called when the request fails with a 4xx or 5xx\nresponse code. Default is nil, do nothing. The function will be\ncalled with the HTTP agent as its argument. Any exceptions thrown\nby this function will become agent-errors. Any exceptions thrown by\nthis function will be added to the agent's error queue (see\nagent-errors).\n",
"name":"http-agent"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L122",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L122",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/response-body-bytes",
"namespace":"clojure.contrib.http.agent",
@@ -2277,7 +2277,7 @@
"Returns a Java byte array of the content returned by the server.",
"name":"response-body-bytes"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L128",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L128",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/response-body-str",
"namespace":"clojure.contrib.http.agent",
@@ -2286,7 +2286,7 @@
"Returns the HTTP response body as a string. The string will be\ncreated using the encoding specified by the server, or\n*default-encoding* if it is not specified.",
"name":"response-body-str"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L153",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L153",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/response-headers",
"namespace":"clojure.contrib.http.agent",
@@ -2295,7 +2295,7 @@
"Returns a String=>String map of HTTP response headers. Header\nnames are converted to all lower-case. If a header appears more\nthan once, only the last value is returned.",
"name":"response-headers"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L162",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L162",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/response-headers-seq",
"namespace":"clojure.contrib.http.agent",
@@ -2304,7 +2304,7 @@
"Returns the HTTP response headers in order as a sequence of\n[String,String] pairs. The first 'header' name may be null for the\nHTTP status line.",
"name":"response-headers-seq"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L147",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L147",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/response-message",
"namespace":"clojure.contrib.http.agent",
@@ -2313,7 +2313,7 @@
"Returns the HTTP response message (e.g. 'Not Found'), for this request.",
"name":"response-message"},
{"source-url":
- "http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L141",
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L141",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/response-status",
"namespace":"clojure.contrib.http.agent",
@@ -2322,6 +2322,15 @@
"Returns the Integer response status code (e.g. 200, 404) for this request.",
"name":"response-status"},
{"source-url":
+ "http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L175",
+ "wiki-url":
+ "http://richhickey.github.com/clojure-contrib//http.agent-api.html#http.agent/response-success?",
+ "namespace":"clojure.contrib.http.agent",
+ "arglists":[["http-agnt"]],
+ "doc":
+ "Returns true if the HTTP response code was in the 200-299 range.",
+ "name":"response-success?"},
+ {"source-url":
"http://github.com/richhickey/clojure-contrib/blob/5f3988ffe6eb894448cbdc2bd4ec8b01ba2e10ce/src/clojure/contrib/http/connection.clj#L21",
"wiki-url":
"http://richhickey.github.com/clojure-contrib//http.connection-api.html#http.connection/http-connection",
diff --git a/http.agent-api.html b/http.agent-api.html
index ddb797d2..6d88a852 100644
--- a/http.agent-api.html
+++ b/http.agent-api.html
@@ -68,6 +68,8 @@ namespace.
<a href="#http.agent/response-message">response-message</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#http.agent/response-status">response-status</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
+ <a href="#http.agent/response-success?">response-success?</a>
</div>
<br />
</div>
@@ -141,7 +143,7 @@ by this function will become agent-errors. Any exceptions thrown by
this function will be added to the agent's error queue (see
agent-errors).
</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L58" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L58" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="http.agent/response-body-bytes">response-body-bytes</h2>
@@ -149,7 +151,7 @@ agent-errors).
<pre id="var-usage">Usage: (response-body-bytes a)
</pre>
<pre id="var-docstr">Returns a Java byte array of the content returned by the server.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L122" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L122" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="http.agent/response-body-str">response-body-str</h2>
@@ -159,7 +161,7 @@ agent-errors).
<pre id="var-docstr">Returns the HTTP response body as a string. The string will be
created using the encoding specified by the server, or
*default-encoding* if it is not specified.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L128" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L128" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="http.agent/response-headers">response-headers</h2>
@@ -169,7 +171,7 @@ created using the encoding specified by the server, or
<pre id="var-docstr">Returns a String=&gt;String map of HTTP response headers. Header
names are converted to all lower-case. If a header appears more
than once, only the last value is returned.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L153" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L153" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="http.agent/response-headers-seq">response-headers-seq</h2>
@@ -179,7 +181,7 @@ 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/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L162" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L162" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="http.agent/response-message">response-message</h2>
@@ -187,7 +189,7 @@ HTTP status line.</pre>
<pre id="var-usage">Usage: (response-message a)
</pre>
<pre id="var-docstr">Returns the HTTP response message (e.g. 'Not Found'), for this request.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L147" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L147" id="var-source">Source</a>
</div><div id="var-entry">
<hr />
<h2 id="http.agent/response-status">response-status</h2>
@@ -195,7 +197,15 @@ HTTP status line.</pre>
<pre id="var-usage">Usage: (response-status a)
</pre>
<pre id="var-docstr">Returns the Integer response status code (e.g. 200, 404) for this request.</pre>
- <a href="http://github.com/richhickey/clojure-contrib/blob/6fea921c91d453c750586c960ec92caacf4fa5e6/src/clojure/contrib/http/agent.clj#L141" id="var-source">Source</a>
+ <a href="http://github.com/richhickey/clojure-contrib/blob/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L141" id="var-source">Source</a>
+</div><div id="var-entry">
+ <hr />
+ <h2 id="http.agent/response-success?">response-success?</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (response-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/05cf6c1e991a9db416a51f1ff5cc8ff2bccac15a/src/clojure/contrib/http/agent.clj#L175" id="var-source">Source</a>
</div>
diff --git a/index.html b/index.html
index 889e53be..aebc0731 100644
--- a/index.html
+++ b/index.html
@@ -895,7 +895,7 @@ defined for any type.</pre>
<pre id="namespace-docstr">Agent-based asynchronous HTTP client.</pre>
Public variables and functions:
- <span id="var-link"><a href="http.agent-api.html#http.agent/http-agent" id="var-tag">http-agent</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-body-bytes" id="var-tag">response-body-bytes</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-body-str" id="var-tag">response-body-str</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-headers" id="var-tag">response-headers</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-headers-seq" id="var-tag">response-headers-seq</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-message" id="var-tag">response-message</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-status" id="var-tag">response-status</a> </span><br />
+ <span id="var-link"><a href="http.agent-api.html#http.agent/http-agent" id="var-tag">http-agent</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-body-bytes" id="var-tag">response-body-bytes</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-body-str" id="var-tag">response-body-str</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-headers" id="var-tag">response-headers</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-headers-seq" id="var-tag">response-headers-seq</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-message" id="var-tag">response-message</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-status" id="var-tag">response-status</a> </span><span id="var-link"><a href="http.agent-api.html#http.agent/response-success?" id="var-tag">response-success?</a> </span><br />
</div><div id="namespace-entry">
<br />