RubyGems - yunhe - Versions diffs - 0.0.1 - Mend

yunhe 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

checksums.yaml +7 -0
data/.gitignore +2 -0
data/Gemfile +1 -0
data/README.md +1 -0
data/Rakefile +15 -0
data/doc/Gemfile.html +87 -0
data/doc/README_md.html +85 -0
data/doc/Yunhe/Consumer.html +194 -0
data/doc/Yunhe/Core.html +396 -0
data/doc/Yunhe/Producer.html +194 -0
data/doc/Yunhe.html +164 -0
data/doc/created.rid +9 -0
data/doc/css/fonts.css +167 -0
data/doc/css/rdoc.css +590 -0
data/doc/fonts/Lato-Light.ttf +0 -0
data/doc/fonts/Lato-LightItalic.ttf +0 -0
data/doc/fonts/Lato-Regular.ttf +0 -0
data/doc/fonts/Lato-RegularItalic.ttf +0 -0
data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +101 -0
data/doc/js/darkfish.js +161 -0
data/doc/js/jquery.js +4 -0
data/doc/js/navigation.js +142 -0
data/doc/js/navigation.js.gz +0 -0
data/doc/js/search.js +109 -0
data/doc/js/search_index.js +1 -0
data/doc/js/search_index.js.gz +0 -0
data/doc/js/searcher.js +228 -0
data/doc/js/searcher.js.gz +0 -0
data/doc/table_of_contents.html +101 -0
data/doc/yunhe_gemspec.html +105 -0
data/lib/yunhe/consumer.rb +24 -0
data/lib/yunhe/core.rb +111 -0
data/lib/yunhe/producer.rb +21 -0
data/lib/yunhe/version.rb +3 -0
data/lib/yunhe.rb +20 -0
data/yunhe.gemspec +18 -0
metadata +107 -0

data/doc/Yunhe/Core.html ADDED Viewed

@@ -0,0 +1,396 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>class Yunhe::Core - RDoc Documentation</title>
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+  </div>
+  <div id="class-metadata">
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+  <p class="link">Object
+</div>
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+  <ul class="link-list" role="directory">
+    <li ><a href="#method-c-new">::new</a>
+    <li ><a href="#method-i-consume_with">#consume_with</a>
+    <li ><a href="#method-i-produce_by">#produce_by</a>
+    <li ><a href="#method-i-terminate">#terminate</a>
+  </ul>
+</div>
+  </div>
+</nav>
+<main role="main" aria-labelledby="class-Yunhe::Core">
+  <h1 id="class-Yunhe::Core" class="class">
+    class Yunhe::Core
+  </h1>
+  <section class="description">
+<p>The core class that manages the producers and consumers.</p>
+  </section>
+  <section id="5Buntitled-5D" class="documentation-section">
+    <section class="attribute-method-details" class="method-section">
+      <header>
+        <h3>Attributes</h3>
+      </header>
+      <div id="attribute-i-consumer_pool" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">consumer_pool</span><span
+            class="attribute-access-type">[R]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="attribute-i-consumer_size" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">consumer_size</span><span
+            class="attribute-access-type">[RW]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="attribute-i-producer_pool" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">producer_pool</span><span
+            class="attribute-access-type">[R]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="attribute-i-producer_size" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">producer_size</span><span
+            class="attribute-access-type">[RW]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="attribute-i-queue" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">queue</span><span
+            class="attribute-access-type">[R]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="attribute-i-queue_size" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">queue_size</span><span
+            class="attribute-access-type">[RW]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+    </section>
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+      <div id="method-c-new" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(options)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Initialize a new yunhe core with options: :producer_size      =&gt; Size of
+the producer pool :consumer_size      =&gt; Size of the consumer pool
+:queue_size         =&gt; Size of the buffer queue</p>
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/yunhe/core.rb, line 19</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>)
+  <span class="ruby-identifier">producer_size</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:producer_size</span>]
+  <span class="ruby-identifier">consumer_size</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:consumer_size</span>]
+  <span class="ruby-identifier">queue_size</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:queue_size</span>]
+  <span class="ruby-ivar">@producer_pool</span> = <span class="ruby-constant">ThreadGroup</span>.<span class="ruby-identifier">new</span>
+  <span class="ruby-ivar">@consumer_pool</span> = <span class="ruby-constant">ThreadGroup</span>.<span class="ruby-identifier">new</span>
+  <span class="ruby-ivar">@queue</span> = <span class="ruby-constant">SizedQueue</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">queue_size</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+    </section>
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+      <div id="method-i-consume_with" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">consume_with</span><span
+            class="method-args">(&task)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Set the consumer task &amp;task: The task that procceed the resources.
+Should take the resource as a paramater:</p>
+<pre>do | resource |
+  ...
+end</pre>
+          <div class="method-source-code" id="consume_with-source">
+            <pre><span class="ruby-comment"># File lib/yunhe/core.rb, line 79</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">consume_with</span> (<span class="ruby-operator">&amp;</span><span class="ruby-identifier">task</span>)
+  <span class="ruby-identifier">each_consumer</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">thread</span> <span class="ruby-operator">|</span>
+    <span class="ruby-identifier">thread</span>.<span class="ruby-identifier">kill</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">consumer_size</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
+    <span class="ruby-identifier">thread</span> = <span class="ruby-constant">Consumer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">queue</span>, <span class="ruby-identifier">task</span>)
+    <span class="ruby-identifier">consumer_pool</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">thread</span>)
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-i-produce_by" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">produce_by</span><span
+            class="method-args">(&task)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Set the producer task &amp;task: The task that produces a new resource.
+Should have the resource returned:</p>
+<pre>do
+  ...
+  return resource
+end</pre>
+          <div class="method-source-code" id="produce_by-source">
+            <pre><span class="ruby-comment"># File lib/yunhe/core.rb, line 62</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">produce_by</span> (<span class="ruby-operator">&amp;</span><span class="ruby-identifier">task</span>)
+  <span class="ruby-identifier">each_producer</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">thread</span> <span class="ruby-operator">|</span>
+    <span class="ruby-identifier">thread</span>.<span class="ruby-identifier">kill</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">producer_size</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
+    <span class="ruby-identifier">thread</span> = <span class="ruby-constant">Producer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">queue</span>, <span class="ruby-identifier">task</span>)
+    <span class="ruby-identifier">producer_pool</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">thread</span>)
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-i-terminate" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">terminate</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Stop the yunhe core. Kill all producer/consumer threads, and clear the
+buffer queue.</p>
+          <div class="method-source-code" id="terminate-source">
+            <pre><span class="ruby-comment"># File lib/yunhe/core.rb, line 91</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">terminate</span>
+  <span class="ruby-identifier">each_producer</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">thread</span> <span class="ruby-operator">|</span>
+    <span class="ruby-identifier">thread</span>.<span class="ruby-identifier">kill</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">each_consumer</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">thread</span> <span class="ruby-operator">|</span>
+    <span class="ruby-identifier">thread</span>.<span class="ruby-identifier">kill</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">queue</span>.<span class="ruby-identifier">clear</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+    </section>
+  </section>
+</main>
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>

data/doc/Yunhe/Producer.html ADDED Viewed

@@ -0,0 +1,194 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8">
+<title>class Yunhe::Producer - RDoc Documentation</title>
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+<script src="../js/jquery.js"></script>
+<script src="../js/darkfish.js"></script>
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+  </div>
+  <div id="class-metadata">
+    <div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+  <p class="link">Thread
+</div>
+    <!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+  <ul class="link-list" role="directory">
+    <li class="calls-super" ><a href="#method-c-new">::new</a>
+  </ul>
+</div>
+  </div>
+</nav>
+<main role="main" aria-labelledby="class-Yunhe::Producer">
+  <h1 id="class-Yunhe::Producer" class="class">
+    class Yunhe::Producer
+  </h1>
+  <section class="description">
+  </section>
+  <section id="5Buntitled-5D" class="documentation-section">
+    <section class="attribute-method-details" class="method-section">
+      <header>
+        <h3>Attributes</h3>
+      </header>
+      <div id="attribute-i-block" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">block</span><span
+            class="attribute-access-type">[RW]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="attribute-i-queue" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">queue</span><span
+            class="attribute-access-type">[RW]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+    </section>
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+      <div id="method-c-new" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(queue, block)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+            <div class="method-calls-super">
+              Calls superclass method
+            </div>
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/yunhe/producer.rb, line 6</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">queue</span>, <span class="ruby-identifier">block</span>)
+  <span class="ruby-keyword">super</span> <span class="ruby-operator">&amp;</span>(<span class="ruby-identifier">method</span>(<span class="ruby-value">:job</span>).<span class="ruby-identifier">to_proc</span>)
+  <span class="ruby-ivar">@block</span> = <span class="ruby-identifier">block</span>
+  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">queue</span> = <span class="ruby-identifier">queue</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+      </div>
+    </section>
+  </section>
+</main>
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>