File: C:/Ruby27-x64/share/doc/ruby/html/Monitor.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Monitor - 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-i-enter">#enter</a>
<li ><a href="#method-i-exit">#exit</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_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_enter">#try_enter</a>
<li ><a href="#method-i-try_mon_enter">#try_mon_enter</a>
<li ><a href="#method-i-wait_for_cond">#wait_for_cond</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Monitor">
<h1 id="class-Monitor" class="class">
class Monitor
</h1>
<section class="description">
<p>Use the <a href="Monitor.html"><code>Monitor</code></a> class when you want to have a lock object for blocks with mutual exclusion.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'monitor'</span>
<span class="ruby-identifier">lock</span> = <span class="ruby-constant">Monitor</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">lock</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
<span class="ruby-comment"># exclusive access</span>
<span class="ruby-keyword">end</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-enter" class="method-detail ">
<div class="method-heading">
<span class="method-name">enter</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="enter-source">
<pre>static VALUE
monitor_enter(VALUE monitor)
{
struct rb_monitor *mc = monitor_ptr(monitor);
if (!mc_owner_p(mc)) {
rb_mutex_lock(mc->mutex);
RB_OBJ_WRITE(monitor, &mc->owner, rb_thread_current());
mc->count = 0;
}
mc->count++;
return Qnil;
}</pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Monitor.html#method-i-mon_enter">mon_enter</a>
</div>
</div>
<div id="method-i-exit" class="method-detail ">
<div class="method-heading">
<span class="method-name">exit</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="exit-source">
<pre>static VALUE
monitor_exit(VALUE monitor)
{
monitor_check_owner(monitor);
struct rb_monitor *mc = monitor_ptr(monitor);
if (mc->count <= 0) rb_bug("monitor_exit: count:%d\n", (int)mc->count);
mc->count--;
if (mc->count == 0) {
RB_OBJ_WRITE(monitor, &mc->owner, Qnil);
rb_mutex_unlock(mc->mutex);
}
return Qnil;
}</pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Monitor.html#method-i-mon_exit">mon_exit</a>
</div>
</div>
<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>static VALUE
monitor_check_owner(VALUE monitor)
{
struct rb_monitor *mc = monitor_ptr(monitor);
if (!mc_owner_p(mc)) {
rb_raise(rb_eThreadError, "current thread not owner");
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-i-mon_enter" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">mon_enter</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Monitor.html#method-i-enter">enter</a>
</div>
</div>
<div id="method-i-mon_exit" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">mon_exit</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Monitor.html#method-i-exit">exit</a>
</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">
<div class="method-source-code" id="mon_locked-3F-source">
<pre>static VALUE
monitor_locked_p(VALUE monitor)
{
struct rb_monitor *mc = monitor_ptr(monitor);
return rb_mutex_locked_p(mc->mutex);
}</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">
<div class="method-source-code" id="mon_owned-3F-source">
<pre>static VALUE
monitor_owned_p(VALUE monitor)
{
struct rb_monitor *mc = monitor_ptr(monitor);
return (rb_mutex_locked_p(mc->mutex) && mc_owner_p(mc)) ? Qtrue : Qfalse;
}</pre>
</div>
</div>
</div>
<div id="method-i-mon_synchronize" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">mon_synchronize</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Monitor.html#method-i-synchronize">synchronize</a>
</div>
</div>
<div id="method-i-mon_try_enter" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">mon_try_enter</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Monitor.html#method-i-try_enter">try_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">
<div class="method-source-code" id="new_cond-source">
<pre><span class="ruby-comment"># File ext/monitor/lib/monitor.rb, line 258</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_cond</span>
<span class="ruby-operator">::</span><span class="ruby-constant">MonitorMixin</span><span class="ruby-operator">::</span><span class="ruby-constant">ConditionVariable</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-synchronize" class="method-detail ">
<div class="method-heading">
<span class="method-name">synchronize</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="synchronize-source">
<pre>static VALUE
monitor_synchronize(VALUE monitor)
{
monitor_enter(monitor);
return rb_ensure(monitor_sync_body, monitor, monitor_sync_ensure, monitor);
}</pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Monitor.html#method-i-mon_synchronize">mon_synchronize</a>
</div>
</div>
<div id="method-i-try_enter" class="method-detail ">
<div class="method-heading">
<span class="method-name">try_enter</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="try_enter-source">
<pre>static VALUE
monitor_try_enter(VALUE monitor)
{
struct rb_monitor *mc = monitor_ptr(monitor);
if (!mc_owner_p(mc)) {
if (!rb_mutex_trylock(mc->mutex)) {
return Qfalse;
}
RB_OBJ_WRITE(monitor, &mc->owner, rb_thread_current());
mc->count = 0;
}
mc->count += 1;
return Qtrue;
}</pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Monitor.html#method-i-try_mon_enter">try_mon_enter</a>, <a href="Monitor.html#method-i-mon_try_enter">mon_try_enter</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 compatibility</p>
</div>
<div class="aliases">
Alias for: <a href="Monitor.html#method-i-try_enter">try_enter</a>
</div>
</div>
<div id="method-i-wait_for_cond" class="method-detail ">
<div class="method-heading">
<span class="method-name">wait_for_cond</span><span
class="method-args">(p1, p2)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="wait_for_cond-source">
<pre>static VALUE
monitor_wait_for_cond(VALUE monitor, VALUE cond, VALUE timeout)
{
VALUE count = monitor_exit_for_cond(monitor);
struct wait_for_cond_data data = {
monitor,
cond,
timeout,
count,
};
return rb_ensure(monitor_wait_for_cond_body, (VALUE)&data,
monitor_enter_for_cond, (VALUE)&data);
}</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>