File: C:/Ruby27-x64/share/doc/ruby/html/DRb/DRbIdConv.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class DRb::DRbIdConv - 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-to_id">#to_id</a>
<li ><a href="#method-i-to_obj">#to_obj</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-DRb::DRbIdConv">
<h1 id="class-DRb::DRbIdConv" class="class">
class DRb::DRbIdConv
</h1>
<section class="description">
<p><a href="../Class.html"><code>Class</code></a> responsible for converting between an object and its id.</p>
<p>This, the default implementation, uses an object's local <a href="../ObjectSpace.html"><code>ObjectSpace</code></a> __id__ as its id. This means that an object's identification over drb remains valid only while that object instance remains alive within the server runtime.</p>
<p>For alternative mechanisms, see <a href="TimerIdConv.html"><code>DRb::TimerIdConv</code></a> in drb/timeridconv.rb and DRbNameIdConv in sample/name.rb in the full drb distribution.</p>
</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-to_id" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_id</span><span
class="method-args">(obj)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert an object into a reference id.</p>
<p>This implementation returns the object's __id__ in the local object space.</p>
<div class="method-source-code" id="to_id-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 373</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_id</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">obj</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">Object</span>
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">__id__</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">BasicObject</span>
<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">__id__</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_obj" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_obj</span><span
class="method-args">(ref)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Convert an object reference id to an object.</p>
<p>This implementation looks up the reference id in the local object space and returns the object it refers to.</p>
<div class="method-source-code" id="to_obj-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 365</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_obj</span>(<span class="ruby-identifier">ref</span>)
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">_id2ref</span>(<span class="ruby-identifier">ref</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>