12 lines
9.8 KiB
HTML
12 lines
9.8 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>youyesyet.outqueue 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">Youyesyet</span> <span class="project-version">0.2.1</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">Topics</span></h3><ul><li class="depth-1 "><a href="authorisation.html"><div class="inner"><span>Security and authorisation</span></div></a></li><li class="depth-1 "><a href="competitors.html"><div class="inner"><span>Competitor Analysis</span></div></a></li><li class="depth-1 "><a href="database.html"><div class="inner"><span>Database Specification</span></div></a></li><li class="depth-1 "><a href="scaling.html"><div class="inner"><span>YouYesYet: Scaling</span></div></a></li><li class="depth-1 "><a href="userspec.html"><div class="inner"><span>YouYesYet: User-oriented specification</span></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>youyesyet</span></div></div></li><li class="depth-2 branch"><a href="youyesyet.config.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>config</span></div></a></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>db</span></div></div></li><li class="depth-3"><a href="youyesyet.db.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="youyesyet.handler.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>handler</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.layout.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>layout</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.locality.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>locality</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.middleware.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>middleware</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.oauth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oauth</span></div></a></li><li class="depth-2 branch current"><a href="youyesyet.outqueue.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outqueue</span></div></a></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>routes</span></div></div></li><li class="depth-3 branch"><a href="youyesyet.routes.auto.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auto</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.auto-json.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auto-json</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.home.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>home</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.issue-experts.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>issue-experts</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.logged-in.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>logged-in</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.manual.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>manual</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.oauth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oauth</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.rest.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.roles.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>roles</span></div></a></li><li class="depth-3"><a href="youyesyet.routes.services.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>services</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.utils.html"><div class="inner"><span class="tree" style="top: -331px;"><span class="top" style="height: 340px;"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="youyesyet.validation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>validation</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="youyesyet.outqueue.html#var-add.21"><div class="inner"><span>add!</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-count"><div class="inner"><span>count</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-lock.21"><div class="inner"><span>lock!</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-locked.3F"><div class="inner"><span>locked?</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-maybe-process-next"><div class="inner"><span>maybe-process-next</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-new-queue"><div class="inner"><span>new-queue</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-peek"><div class="inner"><span>peek</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-queue.3F"><div class="inner"><span>queue?</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-take.21"><div class="inner"><span>take!</span></div></a></li><li class="depth-1"><a href="youyesyet.outqueue.html#var-unlock.21"><div class="inner"><span>unlock!</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">youyesyet.outqueue</h1><div class="doc"><pre class="plaintext">Queue of messages waiting to be sent to the server.
|
|
</pre></div><div class="public anchor" id="var-add.21"><h3>add!</h3><div class="usage"><code>(add! q item)</code></div><div class="doc"><pre class="plaintext">Add this item to the queue.
|
|
</pre></div></div><div class="public anchor" id="var-count"><h3>count</h3><div class="usage"><code>(count q)</code></div><div class="doc"><pre class="plaintext">Return the count of items currently in the queue.
|
|
</pre></div></div><div class="public anchor" id="var-lock.21"><h3>lock!</h3><div class="usage"><code>(lock! q)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-locked.3F"><h3>locked?</h3><div class="usage"><code>(locked? q)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div><div class="public anchor" id="var-maybe-process-next"><h3>maybe-process-next</h3><div class="usage"><code>(maybe-process-next q process)</code></div><div class="doc"><pre class="plaintext">Apply this process, assumed to be a function of one argument, to the next
|
|
item in the queue, if the queue is not currently locked; return the value
|
|
returned by process.</pre></div></div><div class="public anchor" id="var-new-queue"><h3>new-queue</h3><div class="usage"><code>(new-queue)</code><code>(new-queue items)</code></div><div class="doc"><pre class="plaintext">Create a new queue
|
|
</pre></div></div><div class="public anchor" id="var-peek"><h3>peek</h3><div class="usage"><code>(peek q)</code></div><div class="doc"><pre class="plaintext">Look at the next item which could be removed from the queue.
|
|
</pre></div></div><div class="public anchor" id="var-queue.3F"><h3>queue?</h3><div class="usage"><code>(queue? x)</code></div><div class="doc"><pre class="plaintext">True if x is a queue, else false.
|
|
</pre></div></div><div class="public anchor" id="var-take.21"><h3>take!</h3><div class="usage"><code>(take! q)</code></div><div class="doc"><pre class="plaintext">Return the first item from the queue, rebind the queue to the remaining
|
|
items. If the queue is empty return nil.</pre></div></div><div class="public anchor" id="var-unlock.21"><h3>unlock!</h3><div class="usage"><code>(unlock! q)</code><code>(unlock! q value)</code></div><div class="doc"><pre class="plaintext">FIXME: write docs</pre></div></div></div></body></html> |