File: C:/Ruby27-x64/share/doc/ruby/html/Rinda/TupleSpace.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rinda::TupleSpace - 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="../Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../DRb/DRbUndumped.html">DRb::DRbUndumped</a>
<li><a class="include" href="../MonitorMixin.html">MonitorMixin</a>
</ul>
</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-create_entry">#create_entry</a>
<li ><a href="#method-i-keep_clean">#keep_clean</a>
<li ><a href="#method-i-move">#move</a>
<li ><a href="#method-i-need_keeper-3F">#need_keeper?</a>
<li ><a href="#method-i-notify">#notify</a>
<li ><a href="#method-i-notify_event">#notify_event</a>
<li ><a href="#method-i-read">#read</a>
<li ><a href="#method-i-read_all">#read_all</a>
<li ><a href="#method-i-start_keeper">#start_keeper</a>
<li ><a href="#method-i-take">#take</a>
<li ><a href="#method-i-write">#write</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rinda::TupleSpace">
<h1 id="class-Rinda::TupleSpace" class="class">
class Rinda::TupleSpace
</h1>
<section class="description">
<p>The Tuplespace manages access to the tuples it contains, ensuring mutual exclusion requirements are met.</p>
<p>The <code>sec</code> option for the write, take, move, read and notify methods may either be a number of seconds or a Renewer object.</p>
</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">(period=60)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="TupleSpace.html"><code>TupleSpace</code></a>. <code>period</code> is used to control how often to look for dead tuples after modifications to the <a href="TupleSpace.html"><code>TupleSpace</code></a>.</p>
<p>If no dead tuples are found <code>period</code> seconds after the last modification, the <a href="TupleSpace.html"><code>TupleSpace</code></a> will stop looking for dead tuples.</p>
<div class="method-calls-super">
Calls superclass method
<a href="../MonitorMixin.html#method-c-new"><code>MonitorMixin::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 437</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">period</span>=<span class="ruby-value">60</span>)
<span class="ruby-keyword">super</span>()
<span class="ruby-ivar">@bag</span> = <span class="ruby-constant">TupleBag</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@read_waiter</span> = <span class="ruby-constant">TupleBag</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@take_waiter</span> = <span class="ruby-constant">TupleBag</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@notify_waiter</span> = <span class="ruby-constant">TupleBag</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@period</span> = <span class="ruby-identifier">period</span>
<span class="ruby-ivar">@keeper</span> = <span class="ruby-keyword">nil</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-move" class="method-detail ">
<div class="method-heading">
<span class="method-name">move</span><span
class="method-args">(port, tuple, sec=nil) { |template| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Moves <code>tuple</code> to <code>port</code>.</p>
<div class="method-source-code" id="move-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 484</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">move</span>(<span class="ruby-identifier">port</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">template</span> = <span class="ruby-constant">WaitTemplateEntry</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>)
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">template</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">entry</span> = <span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>
<span class="ruby-identifier">port</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">port</span>
<span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">entry</span>)
<span class="ruby-identifier">notify_event</span>(<span class="ruby-string">'take'</span>, <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">port</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RequestExpiredError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">expired?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@take_waiter</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-identifier">start_keeper</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">expires</span>
<span class="ruby-keyword">while</span> <span class="ruby-keyword">true</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RequestCanceledError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">canceled?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RequestExpiredError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">expired?</span>
<span class="ruby-identifier">entry</span> = <span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>
<span class="ruby-identifier">port</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">port</span>
<span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">entry</span>)
<span class="ruby-identifier">notify_event</span>(<span class="ruby-string">'take'</span>, <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">port</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">template</span>.<span class="ruby-identifier">wait</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-ivar">@take_waiter</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</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">(event, tuple, sec=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers for notifications of <code>event</code>. Returns a <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a>. See <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a> for examples of how to listen for notifications.</p>
<p><code>event</code> can be:</p>
<dl class="rdoc-list note-list"><dt>'write'
<dd>
<p>A tuple was added</p>
</dd><dt>'take'
<dd>
<p>A tuple was taken or moved</p>
</dd><dt>'delete'
<dd>
<p>A tuple was lost after being overwritten or expiring</p>
</dd></dl>
<p>The <a href="TupleSpace.html"><code>TupleSpace</code></a> will also notify you of the 'close' event when the <a href="NotifyTemplateEntry.html"><code>NotifyTemplateEntry</code></a> has expired.</p>
<div class="method-source-code" id="notify-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 567</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notify</span>(<span class="ruby-identifier">event</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">template</span> = <span class="ruby-constant">NotifyTemplateEntry</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">event</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@notify_waiter</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">template</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-read" class="method-detail ">
<div class="method-heading">
<span class="method-name">read</span><span
class="method-args">(tuple, sec=nil) { |template| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads <code>tuple</code>, but does not remove it.</p>
<div class="method-source-code" id="read-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 521</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>(<span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">template</span> = <span class="ruby-constant">WaitTemplateEntry</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>)
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">template</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">entry</span> = <span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RequestExpiredError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">expired?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@read_waiter</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-identifier">start_keeper</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">expires</span>
<span class="ruby-identifier">template</span>.<span class="ruby-identifier">wait</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RequestCanceledError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">canceled?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RequestExpiredError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">expired?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">template</span>.<span class="ruby-identifier">found</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-ivar">@read_waiter</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-read_all" class="method-detail ">
<div class="method-heading">
<span class="method-name">read_all</span><span
class="method-args">(tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns all tuples matching <code>tuple</code>. Does not remove the found tuples.</p>
<div class="method-source-code" id="read_all-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 545</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read_all</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-identifier">template</span> = <span class="ruby-constant">WaitTemplateEntry</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">entry</span> = <span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">find_all</span>(<span class="ruby-identifier">template</span>)
<span class="ruby-identifier">entry</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">e</span>.<span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-take" class="method-detail ">
<div class="method-heading">
<span class="method-name">take</span><span
class="method-args">(tuple, sec=nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes <code>tuple</code></p>
<div class="method-source-code" id="take-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 477</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">take</span>(<span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">move</span>(<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">(tuple, sec=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>tuple</code></p>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 450</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">create_entry</span>(<span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">expired?</span>
<span class="ruby-ivar">@read_waiter</span>.<span class="ruby-identifier">find_all_template</span>(<span class="ruby-identifier">entry</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">template</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">template</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">notify_event</span>(<span class="ruby-string">'write'</span>, <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>)
<span class="ruby-identifier">notify_event</span>(<span class="ruby-string">'delete'</span>, <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">entry</span>)
<span class="ruby-identifier">start_keeper</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">expires</span>
<span class="ruby-ivar">@read_waiter</span>.<span class="ruby-identifier">find_all_template</span>(<span class="ruby-identifier">entry</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">template</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">template</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">tuple</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@take_waiter</span>.<span class="ruby-identifier">find_all_template</span>(<span class="ruby-identifier">entry</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">template</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">template</span>.<span class="ruby-identifier">signal</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">notify_event</span>(<span class="ruby-string">'write'</span>, <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">entry</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-create_entry" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_entry</span><span
class="method-args">(tuple, sec)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="create_entry-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 577</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_entry</span>(<span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>)
<span class="ruby-constant">TupleEntry</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">tuple</span>, <span class="ruby-identifier">sec</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-keep_clean" class="method-detail ">
<div class="method-heading">
<span class="method-name">keep_clean</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes dead tuples.</p>
<div class="method-source-code" id="keep_clean-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 584</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">keep_clean</span>
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-ivar">@read_waiter</span>.<span class="ruby-identifier">delete_unless_alive</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">e</span>.<span class="ruby-identifier">signal</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@take_waiter</span>.<span class="ruby-identifier">delete_unless_alive</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">e</span>.<span class="ruby-identifier">signal</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@notify_waiter</span>.<span class="ruby-identifier">delete_unless_alive</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">e</span>.<span class="ruby-identifier">notify</span>([<span class="ruby-string">'close'</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">delete_unless_alive</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">notify_event</span>(<span class="ruby-string">'delete'</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-need_keeper-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">need_keeper?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Checks the tuplespace to see if it needs cleaning.</p>
<div class="method-source-code" id="need_keeper-3F-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 631</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">need_keeper?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@bag</span>.<span class="ruby-identifier">has_expires?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@read_waiter</span>.<span class="ruby-identifier">has_expires?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@take_waiter</span>.<span class="ruby-identifier">has_expires?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@notify_waiter</span>.<span class="ruby-identifier">has_expires?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-notify_event" class="method-detail ">
<div class="method-heading">
<span class="method-name">notify_event</span><span
class="method-args">(event, tuple)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Notifies all registered listeners for <code>event</code> of a status change of <code>tuple</code>.</p>
<div class="method-source-code" id="notify_event-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 605</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notify_event</span>(<span class="ruby-identifier">event</span>, <span class="ruby-identifier">tuple</span>)
<span class="ruby-identifier">ev</span> = [<span class="ruby-identifier">event</span>, <span class="ruby-identifier">tuple</span>]
<span class="ruby-ivar">@notify_waiter</span>.<span class="ruby-identifier">find_all_template</span>(<span class="ruby-identifier">ev</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">template</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">template</span>.<span class="ruby-identifier">notify</span>(<span class="ruby-identifier">ev</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-start_keeper" class="method-detail ">
<div class="method-heading">
<span class="method-name">start_keeper</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a thread that scans the tuplespace for expired tuples.</p>
<div class="method-source-code" id="start_keeper-source">
<pre><span class="ruby-comment"># File lib/rinda/tuplespace.rb, line 615</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_keeper</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@keeper</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@keeper</span>.<span class="ruby-identifier">alive?</span>
<span class="ruby-ivar">@keeper</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">while</span> <span class="ruby-keyword">true</span>
<span class="ruby-identifier">sleep</span>(<span class="ruby-ivar">@period</span>)
<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">need_keeper?</span>
<span class="ruby-identifier">keep_clean</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</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>