File: C:/Ruby27-x64/share/doc/ruby/html/MonitorMixin.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module MonitorMixin - 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 id="class-metadata">
<!-- 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-extend_object">::extend_object</a>
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-mon_check_owner">#mon_check_owner</a>
<li ><a href="#method-i-mon_enter">#mon_enter</a>
<li ><a href="#method-i-mon_exit">#mon_exit</a>
<li ><a href="#method-i-mon_initialize">#mon_initialize</a>
<li ><a href="#method-i-mon_locked-3F">#mon_locked?</a>
<li ><a href="#method-i-mon_owned-3F">#mon_owned?</a>
<li ><a href="#method-i-mon_synchronize">#mon_synchronize</a>
<li ><a href="#method-i-mon_try_enter">#mon_try_enter</a>
<li ><a href="#method-i-new_cond">#new_cond</a>
<li ><a href="#method-i-synchronize">#synchronize</a>
<li ><a href="#method-i-try_mon_enter">#try_mon_enter</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-MonitorMixin">
<h1 id="module-MonitorMixin" class="module">
module MonitorMixin
</h1>
<section class="description">
</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-extend_object" class="method-detail ">
<div class="method-heading">
<span class="method-name">extend_object</span><span
class="method-args">(obj)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="extend_object-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 153</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">extend_object</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">__send__</span>(<span class="ruby-value">:mon_initialize</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">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Use <code>extend MonitorMixin</code> or <code>include MonitorMixin</code> instead of this constructor. Have look at the examples above to understand how to use this module.</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 223</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-identifier">mon_initialize</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-mon_enter" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_enter</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Enters exclusive section.</p>
<div class="method-source-code" id="mon_enter-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 170</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_enter</span>
<span class="ruby-ivar">@mon_data</span>.<span class="ruby-identifier">enter</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mon_exit" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_exit</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Leaves exclusive section.</p>
<div class="method-source-code" id="mon_exit-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 177</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_exit</span>
<span class="ruby-identifier">mon_check_owner</span>
<span class="ruby-ivar">@mon_data</span>.<span class="ruby-identifier">exit</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mon_locked-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_locked?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if this monitor is locked by any thread</p>
<div class="method-source-code" id="mon_locked-3F-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 185</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_locked?</span>
<span class="ruby-ivar">@mon_data</span>.<span class="ruby-identifier">mon_locked?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mon_owned-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_owned?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if this monitor is locked by current thread.</p>
<div class="method-source-code" id="mon_owned-3F-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 192</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_owned?</span>
<span class="ruby-ivar">@mon_data</span>.<span class="ruby-identifier">mon_owned?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mon_synchronize" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_synchronize</span><span
class="method-args">(&b)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Enters exclusive section and executes the block. Leaves the exclusive section automatically when the block exits. See example under <code>MonitorMixin</code>.</p>
<div class="method-source-code" id="mon_synchronize-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 201</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_synchronize</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-ivar">@mon_data</span>.<span class="ruby-identifier">synchronize</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="MonitorMixin.html#method-i-synchronize">synchronize</a>
</div>
</div>
<div id="method-i-mon_try_enter" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_try_enter</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Attempts to enter exclusive section. Returns <code>false</code> if lock fails.</p>
<div class="method-source-code" id="mon_try_enter-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 161</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_try_enter</span>
<span class="ruby-ivar">@mon_data</span>.<span class="ruby-identifier">try_enter</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="MonitorMixin.html#method-i-try_mon_enter">try_mon_enter</a>
</div>
</div>
<div id="method-i-new_cond" class="method-detail ">
<div class="method-heading">
<span class="method-name">new_cond</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="MonitorMixin/ConditionVariable.html"><code>MonitorMixin::ConditionVariable</code></a> associated with the <a href="Monitor.html"><code>Monitor</code></a> object.</p>
<div class="method-source-code" id="new_cond-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 210</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_cond</span>
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@mon_data</span>)
<span class="ruby-identifier">mon_initialize</span>
<span class="ruby-ivar">@mon_initialized_by_new_cond</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">ConditionVariable</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@mon_data</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-synchronize" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">synchronize</span><span
class="method-args">(&b)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="MonitorMixin.html#method-i-mon_synchronize">mon_synchronize</a>
</div>
</div>
<div id="method-i-try_mon_enter" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">try_mon_enter</span><span
class="method-args">()</span>
</div>
<div class="method-description">
<p>For backward compatibility</p>
</div>
<div class="aliases">
Alias for: <a href="MonitorMixin.html#method-i-mon_try_enter">mon_try_enter</a>
</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-mon_check_owner" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_check_owner</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="mon_check_owner-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 242</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_check_owner</span>
<span class="ruby-ivar">@mon_data</span>.<span class="ruby-identifier">mon_check_owner</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mon_initialize" class="method-detail ">
<div class="method-heading">
<span class="method-name">mon_initialize</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Initializes the <a href="MonitorMixin.html"><code>MonitorMixin</code></a> after being included in a class or when an object has been extended with the <a href="MonitorMixin.html"><code>MonitorMixin</code></a></p>
<div class="method-source-code" id="mon_initialize-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 230</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mon_initialize</span>
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@mon_data</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">defined?</span>(<span class="ruby-ivar">@mon_initialized_by_new_cond</span>)
<span class="ruby-keyword">return</span> <span class="ruby-comment"># already initalized.</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@mon_data_owner_object_id</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">object_id</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ThreadError</span>, <span class="ruby-string">"already initialized"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@mon_data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Monitor</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@mon_data_owner_object_id</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">object_id</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>