Permalink
Browse files

Updated API docs.

  • Loading branch information...
1 parent 8b5fee1 commit 25e6e4ce6326f406698dc645de9623a1ef4fb5fb @otabat committed Feb 20, 2014

Large diffs are not rendered by default.

Oops, something went wrong.

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -1,16 +1,9 @@
<!DOCTYPE html>
-<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>couchbase-clj.config documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Couchbase-clj 0.1.3 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="couchbase-clj.client.html"><span>couchbase-clj.client</span></a></li><li><a href="couchbase-clj.client-builder.html"><span>couchbase-clj.client-builder</span></a></li><li class="current"><a href="couchbase-clj.config.html"><span>couchbase-clj.config</span></a></li><li><a href="couchbase-clj.future.html"><span>couchbase-clj.future</span></a></li><li><a href="couchbase-clj.query.html"><span>couchbase-clj.query</span></a></li><li><a href="couchbase-clj.util.html"><span>couchbase-clj.util</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="couchbase-clj.config.html#var-default-bucket"><span>default-bucket</span></a></li><li><a href="couchbase-clj.config.html#var-default-data-expiry"><span>default-data-expiry</span></a></li><li><a href="couchbase-clj.config.html#var-default-dec-default"><span>default-dec-default</span></a></li><li><a href="couchbase-clj.config.html#var-default-dec-offset"><span>default-dec-offset</span></a></li><li><a href="couchbase-clj.config.html#var-default-inc-default"><span>default-inc-default</span></a></li><li><a href="couchbase-clj.config.html#var-default-inc-offset"><span>default-inc-offset</span></a></li><li><a href="couchbase-clj.config.html#var-default-lock-expiry"><span>default-lock-expiry</span></a></li><li><a href="couchbase-clj.config.html#var-default-password"><span>default-password</span></a></li><li><a href="couchbase-clj.config.html#var-default-persist"><span>default-persist</span></a></li><li><a href="couchbase-clj.config.html#var-default-replicate"><span>default-replicate</span></a></li><li><a href="couchbase-clj.config.html#var-default-uris"><span>default-uris</span></a></li><li><a href="couchbase-clj.config.html#var-default-username"><span>default-username</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>couchbase-clj.config documentation</h2><pre class="doc"></pre><div class="public" id="var-default-bucket"><h3>default-bucket</h3><div class="usage"></div><pre class="doc">Default bucket name.
-You can change the value by using swap! or reset!.
+<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>couchbase-clj.config documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Couchbase-clj 0.2.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="couchbase-clj.client.html"><span>couchbase-clj.client</span></a></li><li><a href="couchbase-clj.client-builder.html"><span>couchbase-clj.client-builder</span></a></li><li class="current"><a href="couchbase-clj.config.html"><span>couchbase-clj.config</span></a></li><li><a href="couchbase-clj.future.html"><span>couchbase-clj.future</span></a></li><li><a href="couchbase-clj.query.html"><span>couchbase-clj.query</span></a></li><li><a href="couchbase-clj.util.html"><span>couchbase-clj.util</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="couchbase-clj.config.html#var-default-bucket"><span>default-bucket</span></a></li><li><a href="couchbase-clj.config.html#var-default-data-expiry"><span>default-data-expiry</span></a></li><li><a href="couchbase-clj.config.html#var-default-dec-default"><span>default-dec-default</span></a></li><li><a href="couchbase-clj.config.html#var-default-dec-offset"><span>default-dec-offset</span></a></li><li><a href="couchbase-clj.config.html#var-default-inc-default"><span>default-inc-default</span></a></li><li><a href="couchbase-clj.config.html#var-default-inc-offset"><span>default-inc-offset</span></a></li><li><a href="couchbase-clj.config.html#var-default-lock-expiry"><span>default-lock-expiry</span></a></li><li><a href="couchbase-clj.config.html#var-default-password"><span>default-password</span></a></li><li><a href="couchbase-clj.config.html#var-default-persist"><span>default-persist</span></a></li><li><a href="couchbase-clj.config.html#var-default-replicate"><span>default-replicate</span></a></li><li><a href="couchbase-clj.config.html#var-default-uris"><span>default-uris</span></a></li><li><a href="couchbase-clj.config.html#var-default-username"><span>default-username</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>couchbase-clj.config documentation</h2><pre class="doc"></pre><div class="public" id="var-default-bucket"><h3>default-bucket</h3><div class="usage"></div><pre class="doc">Default bucket name.
Default value is set to &quot;default&quot;.</pre></div><div class="public" id="var-default-data-expiry"><h3>default-data-expiry</h3><div class="usage"></div><pre class="doc">Default expiry for the data (in seconds).
-You can change the value by using swap! or reset!.
Default value is set to -1.</pre></div><div class="public" id="var-default-dec-default"><h3>default-dec-default</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-default-dec-offset"><h3>default-dec-offset</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-default-inc-default"><h3>default-inc-default</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-default-inc-offset"><h3>default-inc-offset</h3><div class="usage"></div><pre class="doc">Default offset for incrementing the data.
-You can change the value by using swap! or reset!.
Default value is set to 1.</pre></div><div class="public" id="var-default-lock-expiry"><h3>default-lock-expiry</h3><div class="usage"></div><pre class="doc">Default expiry for locking the key (in seconds).
-You can change the value by using swap! or reset!.
Default value is set to 15.</pre></div><div class="public" id="var-default-password"><h3>default-password</h3><div class="usage"></div><pre class="doc">Default bucket password.
-You can change the value by using swap! or reset!.
-Default value is set to &quot;&quot;.</pre></div><div class="public" id="var-default-persist"><h3>default-persist</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-default-replicate"><h3>default-replicate</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-default-uris"><h3>default-uris</h3><div class="usage"></div><pre class="doc">Default URI sequence collection of one or more servers from the cluster.
-You can change the value by using swap! or reset!.
+Default value is set to &quot;&quot;.</pre></div><div class="public" id="var-default-persist"><h3>default-persist</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-default-replicate"><h3>default-replicate</h3><div class="usage"></div><pre class="doc"></pre></div><div class="public" id="var-default-uris"><h3>default-uris</h3><div class="usage"></div><pre class="doc">Default server URIs.
Default value is set to [&quot;http://127.0.0.1:8091/pools&quot;].</pre></div><div class="public" id="var-default-username"><h3>default-username</h3><div class="usage"></div><pre class="doc">Default bucket username.
-You can change the value by using swap! or reset!.
Default value is set to &quot;&quot;.</pre></div></div></body></html>
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>couchbase-clj.future documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Couchbase-clj 0.1.3 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="couchbase-clj.client.html"><span>couchbase-clj.client</span></a></li><li><a href="couchbase-clj.client-builder.html"><span>couchbase-clj.client-builder</span></a></li><li><a href="couchbase-clj.config.html"><span>couchbase-clj.config</span></a></li><li class="current"><a href="couchbase-clj.future.html"><span>couchbase-clj.future</span></a></li><li><a href="couchbase-clj.query.html"><span>couchbase-clj.query</span></a></li><li><a href="couchbase-clj.util.html"><span>couchbase-clj.util</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljBulkGetFuture"><span>-&gt;CouchbaseCljBulkGetFuture</span></a></li><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljGetFuture"><span>-&gt;CouchbaseCljGetFuture</span></a></li><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljHttpFuture"><span>-&gt;CouchbaseCljHttpFuture</span></a></li><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljOperationFuture"><span>-&gt;CouchbaseCljOperationFuture</span></a></li><li><a href="couchbase-clj.future.html#var-ICouchbaseCljFuture"><span>ICouchbaseCljFuture</span></a></li><li><a href="couchbase-clj.future.html#var-cas-response"><span>cas-response</span></a></li><li><a href="couchbase-clj.future.html#var-deref-json"><span>deref-json</span></a></li><li><a href="couchbase-clj.future.html#var-future-cancel"><span>future-cancel</span></a></li><li><a href="couchbase-clj.future.html#var-future-cancelled%3F"><span>future-cancelled?</span></a></li><li><a href="couchbase-clj.future.html#var-future-done%3F"><span>future-done?</span></a></li><li><a href="couchbase-clj.future.html#var-future-get"><span>future-get</span></a></li><li><a href="couchbase-clj.future.html#var-future-get-json"><span>future-get-json</span></a></li><li><a href="couchbase-clj.future.html#var-future-status"><span>future-status</span></a></li><li><a href="couchbase-clj.future.html#var-get-future"><span>get-future</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>couchbase-clj.future documentation</h2><pre class="doc"></pre><div class="public" id="var--%3ECouchbaseCljBulkGetFuture"><h3>-&gt;CouchbaseCljBulkGetFuture</h3><div class="usage"><code>(-&gt;CouchbaseCljBulkGetFuture cf fut)</code></div><pre class="doc">Positional factory function for class couchbase_clj.future.CouchbaseCljBulkGetFuture.
+<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>couchbase-clj.future documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Couchbase-clj 0.2.0-SNAPSHOT API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><span>Namespaces</span></h3><ul><li><a href="couchbase-clj.client.html"><span>couchbase-clj.client</span></a></li><li><a href="couchbase-clj.client-builder.html"><span>couchbase-clj.client-builder</span></a></li><li><a href="couchbase-clj.config.html"><span>couchbase-clj.config</span></a></li><li class="current"><a href="couchbase-clj.future.html"><span>couchbase-clj.future</span></a></li><li><a href="couchbase-clj.query.html"><span>couchbase-clj.query</span></a></li><li><a href="couchbase-clj.util.html"><span>couchbase-clj.util</span></a></li></ul></div><div class="sidebar" id="vars"><h3>Public Vars</h3><ul><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljBulkGetFuture"><span>-&gt;CouchbaseCljBulkGetFuture</span></a></li><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljGetFuture"><span>-&gt;CouchbaseCljGetFuture</span></a></li><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljHttpFuture"><span>-&gt;CouchbaseCljHttpFuture</span></a></li><li><a href="couchbase-clj.future.html#var--%3ECouchbaseCljOperationFuture"><span>-&gt;CouchbaseCljOperationFuture</span></a></li><li><a href="couchbase-clj.future.html#var-ICouchbaseCljFuture"><span>ICouchbaseCljFuture</span></a></li><li><a href="couchbase-clj.future.html#var-cas-response"><span>cas-response</span></a></li><li><a href="couchbase-clj.future.html#var-deref-json"><span>deref-json</span></a></li><li><a href="couchbase-clj.future.html#var-future-cancel"><span>future-cancel</span></a></li><li><a href="couchbase-clj.future.html#var-future-cancelled%3F"><span>future-cancelled?</span></a></li><li><a href="couchbase-clj.future.html#var-future-done%3F"><span>future-done?</span></a></li><li><a href="couchbase-clj.future.html#var-future-get"><span>future-get</span></a></li><li><a href="couchbase-clj.future.html#var-future-get-json"><span>future-get-json</span></a></li><li><a href="couchbase-clj.future.html#var-future-status"><span>future-status</span></a></li><li><a href="couchbase-clj.future.html#var-get-future"><span>get-future</span></a></li></ul></div><div class="namespace-docs" id="content"><h2>couchbase-clj.future documentation</h2><pre class="doc"></pre><div class="public" id="var--%3ECouchbaseCljBulkGetFuture"><h3>-&gt;CouchbaseCljBulkGetFuture</h3><div class="usage"><code>(-&gt;CouchbaseCljBulkGetFuture cf fut)</code></div><pre class="doc">Positional factory function for class couchbase_clj.future.CouchbaseCljBulkGetFuture.
</pre></div><div class="public" id="var--%3ECouchbaseCljGetFuture"><h3>-&gt;CouchbaseCljGetFuture</h3><div class="usage"><code>(-&gt;CouchbaseCljGetFuture cf fut)</code></div><pre class="doc">Positional factory function for class couchbase_clj.future.CouchbaseCljGetFuture.
</pre></div><div class="public" id="var--%3ECouchbaseCljHttpFuture"><h3>-&gt;CouchbaseCljHttpFuture</h3><div class="usage"><code>(-&gt;CouchbaseCljHttpFuture cf fut)</code></div><pre class="doc">Positional factory function for class couchbase_clj.future.CouchbaseCljHttpFuture.
</pre></div><div class="public" id="var--%3ECouchbaseCljOperationFuture"><h3>-&gt;CouchbaseCljOperationFuture</h3><div class="usage"><code>(-&gt;CouchbaseCljOperationFuture cf fut)</code></div><pre class="doc">Positional factory function for class couchbase_clj.future.CouchbaseCljOperationFuture.
@@ -11,18 +11,18 @@
CASResponse/OBSERVE_ERROR_IN_ARGS :observe-error-in-args is returned
CASResponse/OBSERVE_MODIFIED :observe-modified is returned
CASResponse/OBSERVE_TIMEOUT :observe-modified is returnd</pre></div><div class="public" id="var-deref-json"><h3>deref-json</h3><div class="usage"><code>(deref-json clj-future)</code><code>(deref-json clj-future timeout default)</code></div><pre class="doc">Deref a JSON string and return the converted Clojure data.
-With no arguments, the default operation timeout (specified when creating client)
-will be set, and if it has reached, the TimeoutException will be thrown.
+With no arguments, the default operation timeout will be set,
+and if it has reached, the TimeoutException will be thrown.
The variant taking a timeout will return default and continue processing,
if the timeout (in milliseconds) has reached and catched a TimeoutException.</pre></div><div class="public" id="var-future-cancel"><h3>future-cancel</h3><div class="usage"><code>(future-cancel clj-future)</code></div><pre class="doc">Cancel the future, if possible.
</pre></div><div class="public" id="var-future-cancelled%3F"><h3>future-cancelled?</h3><div class="usage"><code>(future-cancelled? clj-future)</code></div><pre class="doc">Returns true if future is cancelled?
</pre></div><div class="public" id="var-future-done%3F"><h3>future-done?</h3><div class="usage"><code>(future-done? clj-future)</code></div><pre class="doc">Returns true if future is done.
</pre></div><div class="public" id="var-future-get"><h3>future-get</h3><div class="usage"><code>(future-get clj-future)</code><code>(future-get clj-future timeout)</code></div><pre class="doc">Get the result data from the Future object.
-With no arguments, the default operation timeout (specified when creating client)
-will be set, and if has reached, the TimeoutException will be thrown.
+With no arguments, the default operation timeout will be set,
+and if has reached, the TimeoutException will be thrown.
You can pass a optional timeout argument in milliseconds.</pre></div><div class="public" id="var-future-get-json"><h3>future-get-json</h3><div class="usage"><code>(future-get-json clj-future)</code><code>(future-get-json clj-future timeout)</code></div><pre class="doc">Get the result data from the Future object that is a JSON string.
-With no arguments, the default operation timeout (specified when creating client)
-will be set, and if has reached, the OperationTimeoutException will be thrown.
+With no arguments, the default operation timeout will be set,
+and if has reached, the OperationTimeoutException will be thrown.
You can pass a optional timeout argument in milliseconds.</pre></div><div class="public" id="var-future-status"><h3>future-status</h3><div class="usage"><code>(future-status clj-future)</code></div><pre class="doc">Return the status of the Future object.
Internally calls a getStatus method.</pre></div><div class="public" id="var-get-future"><h3>get-future</h3><div class="usage"><code>(get-future clj-future)</code></div><pre class="doc">Get the Future object.
</pre></div></div></body></html>
Oops, something went wrong.

0 comments on commit 25e6e4c

Please sign in to comment.