@@ -80,10 +80,11 @@
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000004">backlog</a>
+ <a href="#M000005">backlog</a>
<a href="#M000001">cleanup!</a>
+ <a href="#M000004">fetch</a>
<a href="#M000003">get</a>
- <a href="#M000005">queue_options</a>
+ <a href="#M000006">queue_options</a>
<a href="#M000002">set</a>
</div>
</div>
@@ -106,11 +107,11 @@
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000004" class="method-detail">
- <a name="M000004"></a>
+ <div id="method-M000005" class="method-detail">
+ <a name="M000005"></a>
<div class="method-heading">
- <a href="#M000004" class="method-signature">
+ <a href="#M000005" class="method-signature">
<span class="method-name">backlog</span><span class="method-args">(queue_name)</span>
</a>
</div>
@@ -120,14 +121,14 @@
A snapshot count of unprocessed items for the given <tt>queue_name</tt>
</p>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000004-source">
+ onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000005-source">
<pre>
- <span class="ruby-comment cmt"># File lib/rude_q.rb, line 69</span>
-69: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">backlog</span>(<span class="ruby-identifier">queue_name</span>)
-70: <span class="ruby-identifier">qname</span> = <span class="ruby-identifier">sanitize_queue_name</span>(<span class="ruby-identifier">queue_name</span>)
-71: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">count</span>(<span class="ruby-identifier">:conditions</span> =<span class="ruby-operator">></span> {<span class="ruby-identifier">:queue_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">qname</span>, <span class="ruby-identifier">:processed</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>})
-72: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/rude_q.rb, line 89</span>
+89: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">backlog</span>(<span class="ruby-identifier">queue_name</span>)
+90: <span class="ruby-identifier">qname</span> = <span class="ruby-identifier">sanitize_queue_name</span>(<span class="ruby-identifier">queue_name</span>)
+91: <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">count</span>(<span class="ruby-identifier">:conditions</span> =<span class="ruby-operator">></span> {<span class="ruby-identifier">:queue_name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">qname</span>, <span class="ruby-identifier">:processed</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">false</span>})
+92: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
@@ -163,6 +164,50 @@ Cleanup old processed items
</div>
</div>
+ <div id="method-M000004" class="method-detail">
+ <a name="M000004"></a>
+
+ <div class="method-heading">
+ <a href="#M000004" class="method-signature">
+ <span class="method-name">fetch</span><span class="method-args">(queue_name, &block)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Grab the first item from the queue, and execute the supplied block if there
+is one
+</p>
+<pre>
+ - it will return the value of the block
+
+ >> RudeQueue.fetch(:my_queue) do |data|
+ >> Monster.devour(data)
+ >> end
+ -> nil
+
+ >> status = RudeQueue.fetch(:my_queue) do |data|
+ >> process(data) # returns the value :update in this case
+ >> end
+ -> :update
+ >> status
+ -> :update
+</pre>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000004-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/rude_q.rb, line 82</span>
+82: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">queue_name</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+83: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">data</span> = <span class="ruby-identifier">get</span>(<span class="ruby-identifier">queue_name</span>)
+84: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">data</span>)
+85: <span class="ruby-keyword kw">end</span>
+86: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
<div id="method-M000003" class="method-detail">
<a name="M000003"></a>
@@ -211,11 +256,11 @@ are treated the same)
</div>
</div>
- <div id="method-M000005" class="method-detail">
- <a name="M000005"></a>
+ <div id="method-M000006" class="method-detail">
+ <a name="M000006"></a>
<div class="method-heading">
- <a href="#M000005" class="method-signature">
+ <a href="#M000006" class="method-signature">
<span class="method-name">queue_options</span><span class="method-args">()</span>
</a>
</div>
@@ -247,13 +292,13 @@ href="PessimisticLock.html">RudeQ::PessimisticLock</a> [<b>default</b>]
</li>
</ul>
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000005-source">
+ onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000006-source">
<pre>
- <span class="ruby-comment cmt"># File lib/rude_q.rb, line 105</span>
-105: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">queue_options</span>
-106: <span class="ruby-ivar">@queue_options</span> <span class="ruby-operator">||=</span> {<span class="ruby-identifier">:processed</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:set_flag</span>, <span class="ruby-identifier">:lock</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:pessimistic</span>}
-107: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/rude_q.rb, line 125</span>
+125: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">queue_options</span>
+126: <span class="ruby-ivar">@queue_options</span> <span class="ruby-operator">||=</span> {<span class="ruby-identifier">:processed</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:set_flag</span>, <span class="ruby-identifier">:lock</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:pessimistic</span>}
+127: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
rdoc/classes/RudeQ/ClassMethods.html
@@ -86,11 +86,11 @@
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000009">do!</a>
- <a href="#M000007">do_work</a>
- <a href="#M000008">get_work</a>
- <a href="#M000010">logger</a>
- <a href="#M000006">queue_name</a>
+ <a href="#M000010">do!</a>
+ <a href="#M000008">do_work</a>
+ <a href="#M000009">get_work</a>
+ <a href="#M000011">logger</a>
+ <a href="#M000007">queue_name</a>
</div>
</div>
@@ -112,19 +112,19 @@
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000009" class="method-detail">
- <a name="M000009"></a>
+ <div id="method-M000010" class="method-detail">
+ <a name="M000010"></a>
<div class="method-heading">
- <a href="#M000009" class="method-signature">
+ <a href="#M000010" class="method-signature">
<span class="method-name">do!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000009-source">
+ onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000010-source">
<pre>
<span class="ruby-comment cmt"># File lib/rude_q/worker.rb, line 36</span>
36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">do!</span>
@@ -142,19 +142,19 @@
</div>
</div>
- <div id="method-M000007" class="method-detail">
- <a name="M000007"></a>
+ <div id="method-M000008" class="method-detail">
+ <a name="M000008"></a>
<div class="method-heading">
- <a href="#M000007" class="method-signature">
+ <a href="#M000008" class="method-signature">
<span class="method-name">do_work</span><span class="method-args">(data)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000007-source">
+ onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000008-source">
<pre>
<span class="ruby-comment cmt"># File lib/rude_q/worker.rb, line 28</span>
28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">do_work</span>(<span class="ruby-identifier">data</span>)
@@ -165,19 +165,19 @@
</div>
</div>
- <div id="method-M000008" class="method-detail">
- <a name="M000008"></a>
+ <div id="method-M000009" class="method-detail">
+ <a name="M000009"></a>
<div class="method-heading">
- <a href="#M000008" class="method-signature">
+ <a href="#M000009" class="method-signature">
<span class="method-name">get_work</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000008-source">
+ onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000009-source">
<pre>
<span class="ruby-comment cmt"># File lib/rude_q/worker.rb, line 32</span>
32: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_work</span>
@@ -188,19 +188,19 @@
</div>
</div>
- <div id="method-M000010" class="method-detail">
- <a name="M000010"></a>
+ <div id="method-M000011" class="method-detail">
+ <a name="M000011"></a>
<div class="method-heading">
- <a href="#M000010" class="method-signature">
+ <a href="#M000011" class="method-signature">
<span class="method-name">logger</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000010-source">
+ onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000011-source">
<pre>
<span class="ruby-comment cmt"># File lib/rude_q/worker.rb, line 47</span>
47: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logger</span>
@@ -219,19 +219,19 @@
</div>
</div>
- <div id="method-M000006" class="method-detail">
- <a name="M000006"></a>
+ <div id="method-M000007" class="method-detail">
+ <a name="M000007"></a>
<div class="method-heading">
- <a href="#M000006" class="method-signature">
+ <a href="#M000007" class="method-signature">
<span class="method-name">queue_name</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
- onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000006-source">
+ onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000007-source">
<pre>
<span class="ruby-comment cmt"># File lib/rude_q/worker.rb, line 24</span>
24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">queue_name</span>
rdoc/classes/RudeQ/Worker.html
@@ -1 +1 @@
-Thu, 07 Aug 2008 22:51:44 +0100
+Mon, 19 Jan 2009 22:42:01 +0000
rdoc/created.rid
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Thu Aug 07 21:56:25 +0100 2008</td>
+ <td>Mon Jan 19 22:08:06 +0000 2009</td>
</tr>
</table>
</div>
rdoc/files/README.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Thu Aug 07 21:44:17 +0100 2008</td>
+ <td>Mon Jan 19 22:08:06 +0000 2009</td>
</tr>
</table>
</div>
rdoc/files/lib/rude_q/worker_rb.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Thu Aug 07 22:39:02 +0100 2008</td>
+ <td>Mon Jan 19 22:35:39 +0000 2009</td>
</tr>
</table>
</div>
rdoc/files/lib/rude_q_rb.html
@@ -20,15 +20,16 @@
<div id="index">
<h1 class="section-bar">Methods</h1>
<div id="index-entries">
- <a href="classes/RudeQ/ClassMethods.html#M000004">backlog (RudeQ::ClassMethods)</a><br />
+ <a href="classes/RudeQ/ClassMethods.html#M000005">backlog (RudeQ::ClassMethods)</a><br />
<a href="classes/RudeQ/ClassMethods.html#M000001">cleanup! (RudeQ::ClassMethods)</a><br />
- <a href="classes/RudeQ/Worker.html#M000009">do! (RudeQ::Worker)</a><br />
- <a href="classes/RudeQ/Worker.html#M000007">do_work (RudeQ::Worker)</a><br />
+ <a href="classes/RudeQ/Worker.html#M000010">do! (RudeQ::Worker)</a><br />
+ <a href="classes/RudeQ/Worker.html#M000008">do_work (RudeQ::Worker)</a><br />
+ <a href="classes/RudeQ/ClassMethods.html#M000004">fetch (RudeQ::ClassMethods)</a><br />
<a href="classes/RudeQ/ClassMethods.html#M000003">get (RudeQ::ClassMethods)</a><br />
- <a href="classes/RudeQ/Worker.html#M000008">get_work (RudeQ::Worker)</a><br />
- <a href="classes/RudeQ/Worker.html#M000010">logger (RudeQ::Worker)</a><br />
- <a href="classes/RudeQ/Worker.html#M000006">queue_name (RudeQ::Worker)</a><br />
- <a href="classes/RudeQ/ClassMethods.html#M000005">queue_options (RudeQ::ClassMethods)</a><br />
+ <a href="classes/RudeQ/Worker.html#M000009">get_work (RudeQ::Worker)</a><br />
+ <a href="classes/RudeQ/Worker.html#M000011">logger (RudeQ::Worker)</a><br />
+ <a href="classes/RudeQ/Worker.html#M000007">queue_name (RudeQ::Worker)</a><br />
+ <a href="classes/RudeQ/ClassMethods.html#M000006">queue_options (RudeQ::ClassMethods)</a><br />
<a href="classes/RudeQ/ClassMethods.html#M000002">set (RudeQ::ClassMethods)</a><br />
</div>
</div>
rdoc/fr_method_index.html
d5d1639fdc7705fe445c5d4c550b911fedbd83ac
Matthew Rudy Jacobs
matthewrudyjacobs@gmail.com
http://github.com/matthewrudy/rudeq/commit/2ccc12772eadb270871eda8effd55bfae3e2341c
2ccc12772eadb270871eda8effd55bfae3e2341c
2009-01-19T14:42:09-08:00
2009-01-19T14:42:09-08:00
redo the rdoc
0f58eb5ee1e880c58f068c80210e81e07f060d44
Matthew Rudy Jacobs
matthewrudyjacobs@gmail.com