File: C:/Ruby27-x64/share/doc/ruby/html/Mutex_m.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Mutex_m - 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 ><a href="#method-i-mu_lock">#mu_lock</a>
<li ><a href="#method-i-mu_locked-3F">#mu_locked?</a>
<li ><a href="#method-i-mu_synchronize">#mu_synchronize</a>
<li ><a href="#method-i-mu_try_lock">#mu_try_lock</a>
<li ><a href="#method-i-mu_unlock">#mu_unlock</a>
<li ><a href="#method-i-sleep">#sleep</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Mutex_m">
<h1 id="module-Mutex_m" class="module">
module Mutex_m
</h1>
<section class="description">
<h1 id="module-Mutex_m-label-mutex_m.rb">mutex_m.rb<span><a href="#module-Mutex_m-label-mutex_m.rb">¶</a> <a href="#top">↑</a></span></h1>
<p>When 'mutex_m' is required, any object that extends or includes <a href="Mutex_m.html"><code>Mutex_m</code></a> will be treated like a <a href="Mutex.html"><code>Mutex</code></a>.</p>
<p>Start by requiring the standard library <a href="Mutex_m.html"><code>Mutex_m</code></a>:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">"mutex_m.rb"</span>
</pre>
<p>From here you can extend an object with <a href="Mutex.html"><code>Mutex</code></a> instance methods:</p>
<pre class="ruby"><span class="ruby-identifier">obj</span> = <span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">Mutex_m</span>
</pre>
<p>Or mixin <a href="Mutex_m.html"><code>Mutex_m</code></a> into your module to your class inherit <a href="Mutex.html"><code>Mutex</code></a> instance methods — remember to call super() in your class initialize method.</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">Foo</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">Mutex_m</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-comment"># ...</span>
<span class="ruby-keyword">super</span>()
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># ...</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">Foo</span>.<span class="ruby-identifier">new</span>
<span class="ruby-comment"># this obj can be handled like Mutex</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="VERSION">VERSION
<dd>
</dl>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-mu_lock" class="method-detail ">
<div class="method-heading">
<span class="method-name">mu_lock</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="Mutex.html#method-i-lock"><code>Mutex#lock</code></a></p>
<div class="method-source-code" id="mu_lock-source">
<pre><span class="ruby-comment"># File lib/mutex_m.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mu_lock</span>
<span class="ruby-ivar">@_mutex</span>.<span class="ruby-identifier">lock</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mu_locked-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">mu_locked?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="Mutex.html#method-i-locked-3F"><code>Mutex#locked?</code></a></p>
<div class="method-source-code" id="mu_locked-3F-source">
<pre><span class="ruby-comment"># File lib/mutex_m.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mu_locked?</span>
<span class="ruby-ivar">@_mutex</span>.<span class="ruby-identifier">locked?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mu_synchronize" class="method-detail ">
<div class="method-heading">
<span class="method-name">mu_synchronize</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="Mutex.html#method-i-synchronize"><code>Mutex#synchronize</code></a></p>
<div class="method-source-code" id="mu_synchronize-source">
<pre><span class="ruby-comment"># File lib/mutex_m.rb, line 77</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mu_synchronize</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@_mutex</span>.<span class="ruby-identifier">synchronize</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-mu_try_lock" class="method-detail ">
<div class="method-heading">
<span class="method-name">mu_try_lock</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="Mutex.html#method-i-try_lock"><code>Mutex#try_lock</code></a></p>
<div class="method-source-code" id="mu_try_lock-source">
<pre><span class="ruby-comment"># File lib/mutex_m.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mu_try_lock</span>
<span class="ruby-ivar">@_mutex</span>.<span class="ruby-identifier">try_lock</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mu_unlock" class="method-detail ">
<div class="method-heading">
<span class="method-name">mu_unlock</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="Mutex.html#method-i-unlock"><code>Mutex#unlock</code></a></p>
<div class="method-source-code" id="mu_unlock-source">
<pre><span class="ruby-comment"># File lib/mutex_m.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mu_unlock</span>
<span class="ruby-ivar">@_mutex</span>.<span class="ruby-identifier">unlock</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-sleep" class="method-detail ">
<div class="method-heading">
<span class="method-name">sleep</span><span
class="method-args">(timeout = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="Mutex.html#method-i-sleep"><code>Mutex#sleep</code></a></p>
<div class="method-source-code" id="sleep-source">
<pre><span class="ruby-comment"># File lib/mutex_m.rb, line 102</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sleep</span>(<span class="ruby-identifier">timeout</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@_mutex</span>.<span class="ruby-identifier">sleep</span>(<span class="ruby-identifier">timeout</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>