File: C:/Ruby27-x64/share/doc/ruby/html/Rinda/NotifyTemplateEntry.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rinda::NotifyTemplateEntry - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></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"><a href="TemplateEntry.html">Rinda::TemplateEntry</a>
</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>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-notify">#notify</a>
<li ><a href="#method-i-pop">#pop</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rinda::NotifyTemplateEntry">
<h1 id="class-Rinda::NotifyTemplateEntry" class="class">
class Rinda::NotifyTemplateEntry
</h1>
<section class="description">
<p>A <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a> is returned by <a href="TupleSpace.html#method-i-notify"><code>TupleSpace#notify</code></a> and is notified of <a href="TupleSpace.html"><code>TupleSpace</code></a> changes. You may receive either your subscribed event or the 'close' event when iterating over notifications.</p>
<p>See <a href="TupleSpace.html#method-i-notify_event"><code>TupleSpace#notify_event</code></a> for valid notification types.</p>
<h2 id="class-Rinda::NotifyTemplateEntry-label-Example">Example<span><a href="#class-Rinda::NotifyTemplateEntry-label-Example">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">ts</span> = <span class="ruby-constant">Rinda</span><span class="ruby-operator">::</span><span class="ruby-constant">TupleSpace</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">observer</span> = <span class="ruby-identifier">ts</span>.<span class="ruby-identifier">notify</span> <span class="ruby-string">'write'</span>, [<span class="ruby-keyword">nil</span>]
<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">start</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">observer</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">t</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-value">3</span>.<span class="ruby-identifier">times</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">ts</span>.<span class="ruby-identifier">write</span> [<span class="ruby-identifier">i</span>] }
</pre>
<p>Outputs:</p>
<pre class="ruby">[<span class="ruby-string">'write'</span>, [<span class="ruby-value">0</span>]]
[<span class="ruby-string">'write'</span>, [<span class="ruby-value">1</span>]]
[<span class="ruby-string">'write'</span>, [<span class="ruby-value">2</span>]]
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-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">(place, event, tuple, expires=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a> that watches <code>place</code> for +event+s that match <code>tuple</code>.</p>
<div class="method-calls-super">
Calls superclass method
<a href="TupleEntry.html#method-c-new"><code>Rinda::TupleEntry::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 245</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">place</span>, <span class="ruby-identifier">event</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">expires</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">ary</span> = [<span class="ruby-identifier">event</span>, <span class="ruby-constant">Rinda</span><span class="ruby-operator">::</span><span class="ruby-constant">Template</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tuple</span>)]
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">ary</span>, <span class="ruby-identifier">expires</span>)
<span class="ruby-ivar">@queue</span> = <span class="ruby-constant">Thread</span><span class="ruby-operator">::</span><span class="ruby-constant">Queue</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@done</span> = <span class="ruby-keyword">false</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-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">() { |event, tuple| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Yields event/tuple pairs until this <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a> expires.</p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 273</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span> <span class="ruby-comment"># :yields: event, tuple</span>
<span class="ruby-keyword">while</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@done</span>
<span class="ruby-identifier">it</span> = <span class="ruby-identifier">pop</span>
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">it</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">cancel</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-notify" class="method-detail ">
<div class="method-heading">
<span class="method-name">notify</span><span
class="method-args">(ev)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Called by <a href="TupleSpace.html"><code>TupleSpace</code></a> to notify this <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a> of a new event.</p>
<div class="method-source-code" id="notify-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 255</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notify</span>(<span class="ruby-identifier">ev</span>)
<span class="ruby-ivar">@queue</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">ev</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-pop" class="method-detail ">
<div class="method-heading">
<span class="method-name">pop</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Retrieves a notification. Raises <a href="RequestExpiredError.html"><code>RequestExpiredError</code></a> when this <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a> expires.</p>
<div class="method-source-code" id="pop-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 263</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pop</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RequestExpiredError</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@done</span>
<span class="ruby-identifier">it</span> = <span class="ruby-ivar">@queue</span>.<span class="ruby-identifier">pop</span>
<span class="ruby-ivar">@done</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">it</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'close'</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">it</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>