File: C:/Ruby27-x64/share/doc/ruby/html/Timeout.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Timeout - 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="module">
<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 class="nav-section">
<h3>Table of Contents</h3>
<ul class="link-list" role="directory">
<li><a href="#module-Timeout-label-Synopsis">Synopsis</a>
<li><a href="#module-Timeout-label-Description">Description</a>
<li><a href="#module-Timeout-label-Copyright">Copyright</a>
</ul>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-timeout">::timeout</a>
<li ><a href="#method-i-timeout">#timeout</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Timeout">
<h1 id="module-Timeout" class="module">
module Timeout
</h1>
<section class="description">
<p><a href="Timeout.html"><code>Timeout</code></a> long-running blocks</p>
<h2 id="module-Timeout-label-Synopsis">Synopsis<span><a href="#module-Timeout-label-Synopsis">¶</a> <a href="#top">↑</a></span></h2>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'timeout'</span>
<span class="ruby-identifier">status</span> = <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-value">5</span>) {
<span class="ruby-comment"># Something that should be interrupted if it takes more than 5 seconds...</span>
}
</pre>
<h2 id="module-Timeout-label-Description">Description<span><a href="#module-Timeout-label-Description">¶</a> <a href="#top">↑</a></span></h2>
<p><a href="Timeout.html"><code>Timeout</code></a> provides a way to auto-terminate a potentially long-running operation if it hasn't finished in a fixed amount of time.</p>
<p>Previous versions didn't use a module for namespacing, however <a href="Timeout.html#method-i-timeout"><code>timeout</code></a> is provided for backwards compatibility. You should prefer <a href="Timeout.html#method-c-timeout"><code>Timeout.timeout</code></a> instead.</p>
<h2 id="module-Timeout-label-Copyright">Copyright<span><a href="#module-Timeout-label-Copyright">¶</a> <a href="#top">↑</a></span></h2>
<dl class="rdoc-list note-list"><dt>Copyright
<dd>
<p>(C) 2000 Network Applied Communication Laboratory, Inc.</p>
</dd><dt>Copyright
<dd>
<p>(C) 2000 Information-technology Promotion Agency, Japan</p>
</dd></dl>
</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-timeout" class="method-detail ">
<div class="method-heading">
<span class="method-name">timeout</span><span
class="method-args">(sec, klass = nil, message = nil) { |sec| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Perform an operation in a block, raising an error if it takes longer than <code>sec</code> seconds to complete.</p>
<dl class="rdoc-list note-list"><dt><code>sec</code>
<dd>
<p>Number of seconds to wait for the block to terminate. Any number may be used, including Floats to specify fractional seconds. A value of 0 or <code>nil</code> will execute the block without any timeout.</p>
</dd><dt><code>klass</code>
<dd>
<p><a href="Exception.html"><code>Exception</code></a> <a href="Class.html"><code>Class</code></a> to raise if the block fails to terminate in <code>sec</code> seconds. Omitting will use the default, <a href="Timeout/Error.html"><code>Timeout::Error</code></a></p>
</dd><dt><code>message</code>
<dd>
<p><a href="Timeout/Error.html"><code>Error</code></a> message to raise with <a href="Exception.html"><code>Exception</code></a> <a href="Class.html"><code>Class</code></a>. Omitting will use the default, “execution expired”</p>
</dd></dl>
<p>Returns the result of the block <strong>if</strong> the block completed before <code>sec</code> seconds, otherwise throws an exception, based on the value of <code>klass</code>.</p>
<p>The exception thrown to terminate the given block cannot be rescued inside the block unless <code>klass</code> is given explicitly. However, the block can use ensure to prevent the handling of the exception. For that reason, this method cannot be relied on to enforce timeouts for untrusted blocks.</p>
<p>Note that this is both a method of module <a href="Timeout.html"><code>Timeout</code></a>, so you can <code>include Timeout</code> into your classes so they have a <a href="Timeout.html#method-i-timeout"><code>timeout</code></a> method, as well as a module method, so you can call it directly as <a href="Timeout.html#method-c-timeout"><code>Timeout.timeout()</code></a>.</p>
<div class="method-source-code" id="timeout-source">
<pre><span class="ruby-comment"># File lib/timeout.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">timeout</span>(<span class="ruby-identifier">sec</span>, <span class="ruby-identifier">klass</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>) <span class="ruby-comment">#:yield: +sec+</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">sec</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">zero?</span>
<span class="ruby-identifier">message</span> <span class="ruby-operator">||=</span> <span class="ruby-string">"execution expired"</span>.<span class="ruby-identifier">freeze</span>
<span class="ruby-identifier">from</span> = <span class="ruby-node">"from #{caller_locations(1, 1)[0]}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$DEBUG</span>
<span class="ruby-identifier">e</span> = <span class="ruby-constant">Error</span>
<span class="ruby-identifier">bl</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">exception</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">x</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>
<span class="ruby-identifier">y</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">start</span> {
<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>.<span class="ruby-identifier">name</span> = <span class="ruby-identifier">from</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">sleep</span> <span class="ruby-identifier">sec</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">x</span>.<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">x</span>.<span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>, <span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>)
<span class="ruby-keyword">ensure</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">y</span>
<span class="ruby-identifier">y</span>.<span class="ruby-identifier">kill</span>
<span class="ruby-identifier">y</span>.<span class="ruby-identifier">join</span> <span class="ruby-comment"># make sure y is dead.</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">klass</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">bl</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">klass</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">bt</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">bt</span> = <span class="ruby-constant">Error</span>.<span class="ruby-identifier">catch</span>(<span class="ruby-identifier">message</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">bl</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">level</span> = <span class="ruby-operator">-</span><span class="ruby-identifier">caller</span>(<span class="ruby-constant">CALLER_OFFSET</span>).<span class="ruby-identifier">size</span><span class="ruby-value">-2</span>
<span class="ruby-keyword">while</span> <span class="ruby-constant">THIS_FILE</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">bt</span>[<span class="ruby-identifier">level</span>]
<span class="ruby-identifier">bt</span>.<span class="ruby-identifier">delete_at</span>(<span class="ruby-identifier">level</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span>(<span class="ruby-identifier">e</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">bt</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-timeout" class="method-detail ">
<div class="method-heading">
<span class="method-name">timeout</span><span
class="method-args">(sec, klass = nil, message = nil) { |sec| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Perform an operation in a block, raising an error if it takes longer than <code>sec</code> seconds to complete.</p>
<dl class="rdoc-list note-list"><dt><code>sec</code>
<dd>
<p>Number of seconds to wait for the block to terminate. Any number may be used, including Floats to specify fractional seconds. A value of 0 or <code>nil</code> will execute the block without any timeout.</p>
</dd><dt><code>klass</code>
<dd>
<p><a href="Exception.html"><code>Exception</code></a> <a href="Class.html"><code>Class</code></a> to raise if the block fails to terminate in <code>sec</code> seconds. Omitting will use the default, <a href="Timeout/Error.html"><code>Timeout::Error</code></a></p>
</dd><dt><code>message</code>
<dd>
<p><a href="Timeout/Error.html"><code>Error</code></a> message to raise with <a href="Exception.html"><code>Exception</code></a> <a href="Class.html"><code>Class</code></a>. Omitting will use the default, “execution expired”</p>
</dd></dl>
<p>Returns the result of the block <strong>if</strong> the block completed before <code>sec</code> seconds, otherwise throws an exception, based on the value of <code>klass</code>.</p>
<p>The exception thrown to terminate the given block cannot be rescued inside the block unless <code>klass</code> is given explicitly. However, the block can use ensure to prevent the handling of the exception. For that reason, this method cannot be relied on to enforce timeouts for untrusted blocks.</p>
<p>Note that this is both a method of module <a href="Timeout.html"><code>Timeout</code></a>, so you can <code>include Timeout</code> into your classes so they have a <a href="Timeout.html#method-i-timeout"><code>timeout</code></a> method, as well as a module method, so you can call it directly as <a href="Timeout.html#method-c-timeout"><code>Timeout.timeout()</code></a>.</p>
<div class="method-source-code" id="timeout-source">
<pre><span class="ruby-comment"># File lib/timeout.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">timeout</span>(<span class="ruby-identifier">sec</span>, <span class="ruby-identifier">klass</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>) <span class="ruby-comment">#:yield: +sec+</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">sec</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">zero?</span>
<span class="ruby-identifier">message</span> <span class="ruby-operator">||=</span> <span class="ruby-string">"execution expired"</span>.<span class="ruby-identifier">freeze</span>
<span class="ruby-identifier">from</span> = <span class="ruby-node">"from #{caller_locations(1, 1)[0]}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">$DEBUG</span>
<span class="ruby-identifier">e</span> = <span class="ruby-constant">Error</span>
<span class="ruby-identifier">bl</span> = <span class="ruby-identifier">proc</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">exception</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">x</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>
<span class="ruby-identifier">y</span> = <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">start</span> {
<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>.<span class="ruby-identifier">name</span> = <span class="ruby-identifier">from</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">sleep</span> <span class="ruby-identifier">sec</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">x</span>.<span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">x</span>.<span class="ruby-identifier">raise</span> <span class="ruby-identifier">exception</span>, <span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>)
<span class="ruby-keyword">ensure</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">y</span>
<span class="ruby-identifier">y</span>.<span class="ruby-identifier">kill</span>
<span class="ruby-identifier">y</span>.<span class="ruby-identifier">join</span> <span class="ruby-comment"># make sure y is dead.</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">klass</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">bl</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">klass</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">e</span>
<span class="ruby-identifier">bt</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">bt</span> = <span class="ruby-constant">Error</span>.<span class="ruby-identifier">catch</span>(<span class="ruby-identifier">message</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">bl</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">level</span> = <span class="ruby-operator">-</span><span class="ruby-identifier">caller</span>(<span class="ruby-constant">CALLER_OFFSET</span>).<span class="ruby-identifier">size</span><span class="ruby-value">-2</span>
<span class="ruby-keyword">while</span> <span class="ruby-constant">THIS_FILE</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">bt</span>[<span class="ruby-identifier">level</span>]
<span class="ruby-identifier">bt</span>.<span class="ruby-identifier">delete_at</span>(<span class="ruby-identifier">level</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span>(<span class="ruby-identifier">e</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">bt</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>