File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/ConnectionPool.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::ConnectionPool - 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>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-monotonic_time">::monotonic_time</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-wrap">::wrap</a>
<li ><a href="#method-i-available">#available</a>
<li ><a href="#method-i-checkin">#checkin</a>
<li ><a href="#method-i-checkout">#checkout</a>
<li ><a href="#method-i-get_time">#get_time</a>
<li ><a href="#method-i-shutdown">#shutdown</a>
<li ><a href="#method-i-size">#size</a>
<li ><a href="#method-i-with">#with</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::ConnectionPool">
<h1 id="class-Bundler::ConnectionPool" class="class">
class Bundler::ConnectionPool
</h1>
<section class="description">
<p>Generic connection pool class for e.g. sharing a limited number of network connections among many threads. Note: Connections are lazily created.</p>
<p>Example usage with block (faster):</p>
<pre class="ruby"><span class="ruby-ivar">@pool</span> = <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">ConnectionPool</span>.<span class="ruby-identifier">new</span> { <span class="ruby-constant">Redis</span>.<span class="ruby-identifier">new</span> }
<span class="ruby-ivar">@pool</span>.<span class="ruby-identifier">with</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">redis</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">redis</span>.<span class="ruby-identifier">lpop</span>(<span class="ruby-string">'my-list'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">redis</span>.<span class="ruby-identifier">llen</span>(<span class="ruby-string">'my-list'</span>) <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Using optional timeout override (for that single invocation)</p>
<pre class="ruby"><span class="ruby-ivar">@pool</span>.<span class="ruby-identifier">with</span>(<span class="ruby-value">timeout:</span> <span class="ruby-value">2.0</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">redis</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">redis</span>.<span class="ruby-identifier">lpop</span>(<span class="ruby-string">'my-list'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">redis</span>.<span class="ruby-identifier">llen</span>(<span class="ruby-string">'my-list'</span>) <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Example usage replacing an existing connection (slower):</p>
<pre class="ruby"><span class="ruby-identifier">$redis</span> = <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">ConnectionPool</span>.<span class="ruby-identifier">wrap</span> { <span class="ruby-constant">Redis</span>.<span class="ruby-identifier">new</span> }
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_work</span>
<span class="ruby-identifier">$redis</span>.<span class="ruby-identifier">lpop</span>(<span class="ruby-string">'my-list'</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">$redis</span>.<span class="ruby-identifier">llen</span>(<span class="ruby-string">'my-list'</span>) <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Accepts the following options:</p>
<ul><li>
<p>:size - number of connections to pool, defaults to 5</p>
</li><li>
<p>:timeout - amount of time to wait for a connection if none currently available, defaults to 5 seconds</p>
</li></ul>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="DEFAULTS">DEFAULTS
<dd>
<dt id="GLOBAL_MONOTONIC_CLOCK">GLOBAL_MONOTONIC_CLOCK
<dd><p>Clock that cannot be set and represents monotonic time since some unspecified starting point.</p>
<p>@!visibility private</p>
<dt id="VERSION">VERSION
<dd>
</dl>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-monotonic_time" class="method-detail ">
<div class="method-heading">
<span class="method-name">monotonic_time</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the current time a tracked by the application monotonic clock.</p>
<p>@return [Float] The current monotonic time when `since` not given else</p>
<pre class="ruby"><span class="ruby-identifier">the</span> <span class="ruby-identifier">elapsed</span> <span class="ruby-identifier">monotonic</span> <span class="ruby-identifier">time</span> <span class="ruby-identifier">between</span> <span class="ruby-string">`since`</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">current</span> <span class="ruby-identifier">time</span>
</pre>
<div class="method-source-code" id="monotonic_time-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool/monotonic_time.rb, line 62</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">monotonic_time</span>
<span class="ruby-constant">GLOBAL_MONOTONIC_CLOCK</span>.<span class="ruby-identifier">get_time</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(options = {}, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Connection pool requires a block'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">options</span> = <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-ivar">@size</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:size</span>)
<span class="ruby-ivar">@timeout</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:timeout</span>)
<span class="ruby-ivar">@available</span> = <span class="ruby-constant">TimedStack</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@size</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@key</span> = <span class="ruby-value">:"current-#{@available.object_id}"</span>
<span class="ruby-ivar">@key_count</span> = <span class="ruby-value">:"current-#{@available.object_id}-count"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-wrap" class="method-detail ">
<div class="method-heading">
<span class="method-name">wrap</span><span
class="method-args">(options, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="wrap-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">wrap</span>(<span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-constant">Wrapper</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</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-available" class="method-detail ">
<div class="method-heading">
<span class="method-name">available</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Number of pool entries available for checkout at this instant.</p>
<div class="method-source-code" id="available-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">available</span>
<span class="ruby-ivar">@available</span>.<span class="ruby-identifier">length</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-checkin" class="method-detail ">
<div class="method-heading">
<span class="method-name">checkin</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="checkin-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">checkin</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key</span>]
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key_count</span>] <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
<span class="ruby-ivar">@available</span>.<span class="ruby-identifier">push</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key</span>])
<span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key</span>]= <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key_count</span>]<span class="ruby-operator">-=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">ConnectionPool</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-string">'no connections are checked out'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-checkout" class="method-detail ">
<div class="method-heading">
<span class="method-name">checkout</span><span
class="method-args">(options = {})</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="checkout-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">checkout</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key</span>]
<span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key_count</span>]<span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key_count</span>]= <span class="ruby-value">1</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-ivar">@key</span>]= <span class="ruby-ivar">@available</span>.<span class="ruby-identifier">pop</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@timeout</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-get_time" class="method-detail ">
<div class="method-heading">
<span class="method-name">get_time</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>@!visibility private</p>
<div class="method-source-code" id="get_time-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool/monotonic_time.rb, line 15</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_time</span>
<span class="ruby-constant">Process</span>.<span class="ruby-identifier">clock_gettime</span>(<span class="ruby-constant">Process</span><span class="ruby-operator">::</span><span class="ruby-constant">CLOCK_MONOTONIC</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-shutdown" class="method-detail ">
<div class="method-heading">
<span class="method-name">shutdown</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="shutdown-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shutdown</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@available</span>.<span class="ruby-identifier">shutdown</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-size" class="method-detail ">
<div class="method-heading">
<span class="method-name">size</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Size of this connection pool</p>
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
<span class="ruby-ivar">@size</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-with" class="method-detail ">
<div class="method-heading">
<span class="method-name">with</span><span
class="method-args">(options = {}) { |conn| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>MRI</p>
<div class="method-source-code" id="with-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/connection_pool/lib/connection_pool.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with</span>(<span class="ruby-identifier">options</span> = {})
<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">handle_interrupt</span>(<span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-value">:never</span>) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">conn</span> = <span class="ruby-identifier">checkout</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">handle_interrupt</span>(<span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-value">:immediate</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">conn</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">checkin</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>