docs/langohr.core.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>langohr.core documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Langohr</span> <span class="project-version">6.0.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>langohr</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>amqp091</span></div></div></li><li class="depth-3"><a href="langohr.amqp091.inspection.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>inspection</span></div></a></li><li class="depth-2 branch"><a href="langohr.basic.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>basic</span></div></a></li><li class="depth-2 branch"><a href="langohr.channel.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>channel</span></div></a></li><li class="depth-2 branch"><a href="langohr.confirm.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>confirm</span></div></a></li><li class="depth-2 branch"><a href="langohr.consumers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>consumers</span></div></a></li><li class="depth-2 branch"><a href="langohr.conversion.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>conversion</span></div></a></li><li class="depth-2 branch current"><a href="langohr.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="langohr.exchange.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>exchange</span></div></a></li><li class="depth-2 branch"><a href="langohr.http.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http</span></div></a></li><li class="depth-2 branch"><a href="langohr.http2.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http2</span></div></a></li><li class="depth-2 branch"><a href="langohr.queue.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>queue</span></div></a></li><li class="depth-2 branch"><a href="langohr.shutdown.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>shutdown</span></div></a></li><li class="depth-2 branch"><a href="langohr.tx.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tx</span></div></a></li><li class="depth-2"><a href="langohr.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="langohr.core.html#var-*default-config*"><div class="inner"><span>*default-config*</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-add-blocked-listener"><div class="inner"><span>add-blocked-listener</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-add-shutdown-listener"><div class="inner"><span>add-shutdown-listener</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-automatic-recovery-enabled.3F"><div class="inner"><span>automatic-recovery-enabled?</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-automatic-topology-recovery-enabled.3F"><div class="inner"><span>automatic-topology-recovery-enabled?</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-automatically-recover.3F"><div class="inner"><span>automatically-recover?</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-blocked-listener"><div class="inner"><span>blocked-listener</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-capabilities-of"><div class="inner"><span>capabilities-of</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-Closeable"><div class="inner"><span>Closeable</span></div></a></li><li class="depth-2"><a href="langohr.core.html#var-close"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>close</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-connect"><div class="inner"><span>connect</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-create-channel"><div class="inner"><span>create-channel</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-exception-handler"><div class="inner"><span>exception-handler</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-normalize-settings"><div class="inner"><span>normalize-settings</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-on-queue-recovery"><div class="inner"><span>on-queue-recovery</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-on-recovery"><div class="inner"><span>on-recovery</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-Openable"><div class="inner"><span>Openable</span></div></a></li><li class="depth-2 branch"><a href="langohr.core.html#var-closed.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>closed?</span></div></a></li><li class="depth-2"><a href="langohr.core.html#var-open.3F"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>open?</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-queue-recovery-listener"><div class="inner"><span>queue-recovery-listener</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-settings-from"><div class="inner"><span>settings-from</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-shutdown-listener"><div class="inner"><span>shutdown-listener</span></div></a></li><li class="depth-1"><a href="langohr.core.html#var-thread-factory-from"><div class="inner"><span>thread-factory-from</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">langohr.core</h1><div class="doc"><pre class="plaintext">Functions that work with connections and shared features between connections
and channels (e.g. shutdown listeners).

Relevant guides:

 * <a href="http://clojurerabbitmq.info/articles/connecting.html">http://clojurerabbitmq.info/articles/connecting.html</a>
 * <a href="http://clojurerabbitmq.info/articles/tls.html">http://clojurerabbitmq.info/articles/tls.html</a></pre></div><div class="public anchor" id="var-*default-config*"><h3>*default-config*</h3><h4 class="dynamic">dynamic</h4><div class="usage"></div><div class="doc"><pre class="plaintext">Default connection settings.
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L58">view source</a></div></div><div class="public anchor" id="var-add-blocked-listener"><h3>add-blocked-listener</h3><div class="usage"><code>(add-blocked-listener c on-blocked on-unblocked)</code></div><div class="doc"><pre class="plaintext">Adds a connection.blocked and connection.unblocked listener
on connection and returns it</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L149">view source</a></div></div><div class="public anchor" id="var-add-shutdown-listener"><h3>add-shutdown-listener</h3><div class="usage"><code>(add-shutdown-listener c f)</code></div><div class="doc"><pre class="plaintext">Adds a shutdown listener on connection and returns it
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L132">view source</a></div></div><div class="public anchor" id="var-automatic-recovery-enabled.3F"><h3>automatic-recovery-enabled?</h3><div class="usage"><code>(automatic-recovery-enabled? conn)</code></div><div class="doc"><pre class="plaintext">Returns true if provided connection uses automatic connection recovery
mode, false otherwise</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L179">view source</a></div></div><div class="public anchor" id="var-automatic-topology-recovery-enabled.3F"><h3>automatic-topology-recovery-enabled?</h3><div class="usage"><code>(automatic-topology-recovery-enabled? conn)</code></div><div class="doc"><pre class="plaintext">Returns true if provided connection uses automatic topology recovery
mode, false otherwise</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L190">view source</a></div></div><div class="public anchor" id="var-automatically-recover.3F"><h3>automatically-recover?</h3><h4 class="deprecated">deprecated</h4><div class="usage"><code>(automatically-recover? c)</code></div><div class="doc"><pre class="plaintext">See automatic-recovery-enabled?
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L185">view source</a></div></div><div class="public anchor" id="var-blocked-listener"><h3>blocked-listener</h3><div class="usage"><code>(blocked-listener on-blocked on-unblocked)</code></div><div class="doc"><pre class="plaintext">Reifies connection.blocked and connection.unblocked listener from Clojure
functions</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L139">view source</a></div></div><div class="public anchor" id="var-capabilities-of"><h3>capabilities-of</h3><div class="usage"><code>(capabilities-of conn)</code></div><div class="doc"><pre class="plaintext">Returns capabilities of the broker on the other side of the connection
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L170">view source</a></div></div><div class="public anchor" id="var-Closeable"><h3>Closeable</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-close"><h3>close</h3><div class="usage"><code>(close c)</code></div><div class="doc"><pre class="plaintext">Closes given entity
</pre></div></div></div></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L68">view source</a></div></div><div class="public anchor" id="var-connect"><h3>connect</h3><div class="usage"><code>(connect)</code><code>(connect settings)</code></div><div class="doc"><pre class="plaintext">Creates and returns a new connection to RabbitMQ.
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L103">view source</a></div></div><div class="public anchor" id="var-create-channel"><h3>create-channel</h3><div class="usage"><code>(create-channel &amp; args)</code></div><div class="doc"><pre class="plaintext">Delegates to langohr.channel/open, kept for backwards compatibility
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L119">view source</a></div></div><div class="public anchor" id="var-exception-handler"><h3>exception-handler</h3><div class="usage"><code>(exception-handler {:keys [handle-connection-exception-fn handle-return-listener-exception-fn handle-confirm-listener-exception-fn handle-blocked-listener-exception-fn handle-consumer-exception-fn handle-connection-recovery-exception-fn handle-channel-recovery-exception-fn handle-topology-recovery-exception-fn]})</code></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L239">view source</a></div></div><div class="public anchor" id="var-normalize-settings"><h3>normalize-settings</h3><div class="usage"><code>(normalize-settings config)</code></div><div class="doc"><pre class="plaintext">Normalizes settings by converting a :uri/:host key to (at minimum) a map that contains
:port, :hosts, :username, :password, :vhost. If :port is not supplied, it will be defaulted
to the default AMQP port depending on if :ssl is supplied.</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L281">view source</a></div></div><div class="public anchor" id="var-on-queue-recovery"><h3>on-queue-recovery</h3><div class="usage"><code>(on-queue-recovery conn f)</code></div><div class="doc"><pre class="plaintext">Called when server named queue gets a new name on recovery
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L220">view source</a></div></div><div class="public anchor" id="var-on-recovery"><h3>on-recovery</h3><div class="usage"><code>(on-recovery target recovery-finished-fn)</code><code>(on-recovery target recovery-started-fn recovery-finished-fn)</code></div><div class="doc"><pre class="plaintext">Registers a network recovery callback on a (Langohr) connection or channel
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L196">view source</a></div></div><div class="public anchor" id="var-Openable"><h3>Openable</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-closed.3F"><h3>closed?</h3><div class="usage"><code>(closed? this)</code></div><div class="doc"><pre class="plaintext">Checks whether given entity is closed
</pre></div></div><div class="public anchor" id="var-open.3F"><h3>open?</h3><div class="usage"><code>(open? this)</code></div><div class="doc"><pre class="plaintext">Checks whether given entity is open
</pre></div></div></div></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L79">view source</a></div></div><div class="public anchor" id="var-queue-recovery-listener"><h3>queue-recovery-listener</h3><div class="usage"><code>(queue-recovery-listener f)</code></div><div class="doc"><pre class="plaintext">Reifies a new queue recovery listener that delegates
to a Clojure function.</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L212">view source</a></div></div><div class="public anchor" id="var-settings-from"><h3>settings-from</h3><div class="usage"><code>(settings-from uri)</code></div><div class="doc"><pre class="plaintext">Parses AMQP connection URI and returns a persistent map of settings
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L157">view source</a></div></div><div class="public anchor" id="var-shutdown-listener"><h3>shutdown-listener</h3><div class="usage"><code>(shutdown-listener f)</code></div><div class="doc"><pre class="plaintext">Adds new shutdown signal listener that delegates to given function
</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L125">view source</a></div></div><div class="public anchor" id="var-thread-factory-from"><h3>thread-factory-from</h3><div class="usage"><code>(thread-factory-from f)</code></div><div class="doc"><pre class="plaintext">Instantiates a java.util.concurrent.ThreadFactory that delegates
#newThread to provided Clojure function</pre></div><div class="src-link"><a href="https://github.com/michaelklishin/langohr/blob/v6.0.0-SNAPSHOT/src/clojure/langohr/core.clj#L231">view source</a></div></div></div></body></html>