<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Class: Rumai::IXP::Agent::RangedPool</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '../../..';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="../../../_index.html">Index (R)</a> »
<span class='title'><a href="../../../Rumai.html" title="Rumai (module)">Rumai</a></span> » <span class='title'><a href="../../IXP.html" title="Rumai::IXP (module)">IXP</a></span> » <span class='title'><a href="../Agent.html" title="Rumai::IXP::Agent (class)">Agent</a></span>
»
<span class="title">RangedPool</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Rumai::IXP::Agent::RangedPool
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName"><a href="../../../Object.html" title="Object (class)">Object</a></span>
<ul class="fullTree">
<li><a href="../../../Object.html" title="Object (class)">Object</a></li>
<li class="next">Rumai::IXP::Agent::RangedPool</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/rumai/ixp/transport.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>
A finite, thread-safe pool of range members.
</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="FILL_RATE-constant" class="">FILL_RATE =
<div class="docstring">
<div class="discussion">
<p>
how many new members should be added to the pool when the pool is empty?
</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>10</span></pre></dd>
</dl>
<h2>Instance Method Summary</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (RangedPool) <strong>initialize</strong>(range) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>
A new instance of RangedPool.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#obtain-instance_method" title="#obtain (instance method)">- (Object) <strong>obtain</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Returns an unoccupied range member from the pool.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#release-instance_method" title="#release (instance method)">- (Object) <strong>release</strong>(member) </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Marks the given member as being unoccupied so that it may be occupied again
in the future.
</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<p class="signature first" id="initialize-instance_method">
- (<tt><a href="" title="Rumai::IXP::Agent::RangedPool (class)">RangedPool</a></tt>) <strong>initialize</strong>(range)
</p><div class="docstring">
<div class="discussion">
<p>
A new instance of RangedPool
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63
64
65
66
67</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rumai/ixp/transport.rb', line 61</span>
<span class='kw'>def</span> <span class='id initialize'>initialize</span> <span class='id range'>range</span>
<span class='ivar'>@pos</span> <span class='op'>=</span> <span class='id range'>range</span><span class='period'>.</span><span class='id first'>first</span>
<span class='ivar'>@lim</span> <span class='op'>=</span> <span class='id range'>range</span><span class='period'>.</span><span class='id last'>last</span>
<span class='ivar'>@lim</span> <span class='op'>=</span> <span class='ivar'>@lim</span><span class='period'>.</span><span class='id succ'>succ</span> <span class='kw'>unless</span> <span class='id range'>range</span><span class='period'>.</span><span class='id exclude_end?'>exclude_end?</span>
<span class='ivar'>@pool</span> <span class='op'>=</span> <span class='const'>Queue</span><span class='period'>.</span><span class='id new'>new</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<p class="signature first" id="obtain-instance_method">
- (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>obtain</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Returns an unoccupied range member from the pool.
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rumai/ixp/transport.rb', line 72</span>
<span class='kw'>def</span> <span class='id obtain'>obtain</span>
<span class='kw'>begin</span>
<span class='ivar'>@pool</span><span class='period'>.</span><span class='id deq'>deq</span> <span class='kw'>true</span>
<span class='kw'>rescue</span> <span class='const'>ThreadError</span>
<span class='comment'># pool is empty, so fill it
</span> <span class='const'>FILL_RATE</span><span class='period'>.</span><span class='id times'>times</span> <span class='kw'>do</span>
<span class='kw'>if</span> <span class='ivar'>@pos</span> <span class='op'>!=</span> <span class='ivar'>@lim</span>
<span class='ivar'>@pool</span> <span class='op'><<</span> <span class='ivar'>@pos</span>
<span class='ivar'>@pos</span> <span class='op'>=</span> <span class='ivar'>@pos</span><span class='period'>.</span><span class='id succ'>succ</span>
<span class='kw'>else</span>
<span class='comment'># range is exhausted, so give other threads
</span> <span class='comment'># a chance to fill the pool before retrying
</span> <span class='const'>Thread</span><span class='period'>.</span><span class='id pass'>pass</span>
<span class='kw'>break</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>retry</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="release-instance_method">
- (<tt><a href="../../../Object.html" title="Object (class)">Object</a></tt>) <strong>release</strong>(member)
</p><div class="docstring">
<div class="discussion">
<p>
Marks the given member as being unoccupied so that it may be occupied again
in the future.
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rumai/ixp/transport.rb', line 98</span>
<span class='kw'>def</span> <span class='id release'>release</span> <span class='id member'>member</span>
<span class='ivar'>@pool</span> <span class='op'><<</span> <span class='id member'>member</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Apr 1 00:31:01 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.4 (ruby-1.9.1).
</div>
</body>
</html>