quartermaster/documentation/index.html at master · Workiva/quartermaster · GitHub

1
2
3
<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>Quartermaster API Docs</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/solarized-light.css" /><script type="text/javascript" src="highlight/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> with <a href="https://github.com/xsc/codox-theme-rdash">RDash UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Quartermaster</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 current"><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>quartermaster</span></div></div></li><li class="depth-2 branch"><a href="quartermaster.alpha.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>alpha</span></div></a></li><li class="depth-2 branch"><a href="quartermaster.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"><a href="quartermaster.error.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>error</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Quartermaster</span> </span></h1><h5 class="license">Released under the Apache License, Version 2.0</h5><div class="doc"><p>Manages hierarchies of shared resources in a manner both simple and tolerant to failure.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><a href="https://clojars.org/com.workiva/quartermaster"><img src="https://img.shields.io/clojars/v/com.workiva/quartermaster.svg" /></a><h2>Namespaces</h2><div class="namespace"><h3><a href="quartermaster.alpha.html">quartermaster.alpha</a></h3><div class="doc"><div class="markdown"></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="quartermaster.alpha.html#var-release-user">release-user</a> </li></ul></div></div><div class="namespace"><h3><a href="quartermaster.core.html">quartermaster.core</a></h3><div class="doc"><div class="markdown"></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="quartermaster.core.html#var-*always-block-on-release*">*always-block-on-release*</a> </li><li> <a href="quartermaster.core.html#var-acquiring">acquiring</a> </li><li> <a href="quartermaster.core.html#var-all-handle-maps">all-handle-maps</a> </li><li> <a href="quartermaster.core.html#var-all-resource-managers">all-resource-managers</a> </li><li> <a href="quartermaster.core.html#var-auto-reinitiater">auto-reinitiater</a> </li><li> <a href="quartermaster.core.html#var-auto-releaser">auto-releaser</a> </li><li> <a href="quartermaster.core.html#var-defmanager">defmanager</a> </li><li> <a href="quartermaster.core.html#var-ensure-initiated.21">ensure-initiated!</a> </li><li> <a href="quartermaster.core.html#var-identify-resource-leaks">identify-resource-leaks</a> </li><li> <a href="quartermaster.core.html#var-new-resource-id">new-resource-id</a> </li><li> <a href="quartermaster.core.html#var-overriding">overriding</a> </li><li> <a href="quartermaster.core.html#var-resource-manager">resource-manager</a> </li><li> <a href="quartermaster.core.html#var-ResourceHandle">ResourceHandle</a> </li><li> <a href="quartermaster.core.html#var-SharedResource">SharedResource</a> </li><li> <a href="quartermaster.core.html#var-SharedResourceManager">SharedResourceManager</a> </li><li> <a href="quartermaster.core.html#var-status">status</a> </li><li> <a href="quartermaster.core.html#var-terminated.3F">terminated?</a> </li><li> <a href="quartermaster.core.html#var-testing-for-resource-leaks">testing-for-resource-leaks</a> </li></ul></div></div><div class="namespace"><h3><a href="quartermaster.error.html">quartermaster.error</a></h3><div class="doc"><div class="markdown"></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="quartermaster.error.html#var-manager-error">manager-error</a> </li><li> <a href="quartermaster.error.html#var-raise-manager-error">raise-manager-error</a> </li><li> <a href="quartermaster.error.html#var-raise-terminated">raise-terminated</a> </li><li> <a href="quartermaster.error.html#var-terminated">terminated</a> </li></ul></div></div></div></body></html>