File: C:/Ruby27-x64/share/doc/ruby/html/DRb/DRbObject.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class DRb::DRbObject - 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-c-_load">::_load</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-new_with">::new_with</a>
<li ><a href="#method-c-new_with_uri">::new_with_uri</a>
<li ><a href="#method-i-__drbref">#__drbref</a>
<li ><a href="#method-i-__drburi">#__drburi</a>
<li ><a href="#method-i-_dump">#_dump</a>
<li ><a href="#method-i-method_missing">#method_missing</a>
<li ><a href="#method-i-respond_to-3F">#respond_to?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-DRb::DRbObject">
<h1 id="class-DRb::DRbObject" class="class">
class DRb::DRbObject
</h1>
<section class="description">
<p><a href="../Object.html"><code>Object</code></a> wrapping a reference to a remote drb object.</p>
<p><a href="../Method.html"><code>Method</code></a> calls on this object are relayed to the remote object that this object is a stub for.</p>
</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-_load" class="method-detail ">
<div class="method-heading">
<span class="method-name">_load</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Unmarshall a marshalled <a href="DRbObject.html"><code>DRbObject</code></a>.</p>
<p>If the referenced object is located within the local server, then the object itself is returned. Otherwise, a new <a href="DRbObject.html"><code>DRbObject</code></a> is created to act as a stub for the remote referenced object.</p>
<div class="method-source-code" id="_load-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1050</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">_load</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">ref</span> = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">DRb</span>.<span class="ruby-identifier">here?</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">DRb</span>.<span class="ruby-identifier">to_obj</span>(<span class="ruby-identifier">ref</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">obj</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new_with</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">ref</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">(obj, uri=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new remote object stub.</p>
<p><code>obj</code> is the (local) object we want to create a stub for. Normally this is <code>nil</code>. <code>uri</code> is the <a href="../URI.html"><code>URI</code></a> of the remote object that this will be a stub for.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1088</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-identifier">uri</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@uri</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@ref</span> = <span class="ruby-keyword">nil</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">is_nil</span> = <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">BasicObject</span>
<span class="ruby-identifier">is_nil</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">is_nil</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@uri</span>, <span class="ruby-identifier">option</span> = <span class="ruby-constant">DRbProtocol</span>.<span class="ruby-identifier">uri_option</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-constant">DRb</span>.<span class="ruby-identifier">config</span>)
<span class="ruby-ivar">@ref</span> = <span class="ruby-constant">DRbURIOption</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">option</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">option</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@uri</span> = <span class="ruby-identifier">uri</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">uri</span> <span class="ruby-operator">:</span> (<span class="ruby-constant">DRb</span>.<span class="ruby-identifier">uri</span> <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@ref</span> = <span class="ruby-identifier">obj</span> <span class="ruby-operator">?</span> <span class="ruby-constant">DRb</span>.<span class="ruby-identifier">to_id</span>(<span class="ruby-identifier">obj</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new_with" class="method-detail ">
<div class="method-heading">
<span class="method-name">new_with</span><span
class="method-args">(uri, ref)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a <a href="DRbObject.html"><code>DRb::DRbObject</code></a> given the reference information to the remote host <code>uri</code> and object <code>ref</code>.</p>
<div class="method-source-code" id="new_with-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1064</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new_with</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">ref</span>)
<span class="ruby-identifier">it</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">allocate</span>
<span class="ruby-identifier">it</span>.<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-value">:@uri</span>, <span class="ruby-identifier">uri</span>)
<span class="ruby-identifier">it</span>.<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-value">:@ref</span>, <span class="ruby-identifier">ref</span>)
<span class="ruby-identifier">it</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new_with_uri" class="method-detail ">
<div class="method-heading">
<span class="method-name">new_with_uri</span><span
class="method-args">(uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a new <a href="DRbObject.html"><code>DRbObject</code></a> from a <a href="../URI.html"><code>URI</code></a> alone.</p>
<div class="method-source-code" id="new_with_uri-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1072</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new_with_uri</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">uri</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-__drbref" class="method-detail ">
<div class="method-heading">
<span class="method-name">__drbref</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Get the reference of the object, if local.</p>
<div class="method-source-code" id="__drbref-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1114</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">__drbref</span>
<span class="ruby-ivar">@ref</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-__drburi" class="method-detail ">
<div class="method-heading">
<span class="method-name">__drburi</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Get the <a href="../URI.html"><code>URI</code></a> of the remote object.</p>
<div class="method-source-code" id="__drburi-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1109</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">__drburi</span>
<span class="ruby-ivar">@uri</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-_dump" class="method-detail ">
<div class="method-heading">
<span class="method-name">_dump</span><span
class="method-args">(lv)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Marshall this object.</p>
<p>The <a href="../URI.html"><code>URI</code></a> and ref of the object are marshalled.</p>
<div class="method-source-code" id="_dump-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1079</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_dump</span>(<span class="ruby-identifier">lv</span>)
<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>([<span class="ruby-ivar">@uri</span>, <span class="ruby-ivar">@ref</span>])
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-method_missing" class="method-detail ">
<div class="method-heading">
<span class="method-name">method_missing</span><span
class="method-args">(msg_id, *a, &b)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="method_missing-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1134</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">method_missing</span>(<span class="ruby-identifier">msg_id</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">a</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-keyword">if</span> <span class="ruby-constant">DRb</span>.<span class="ruby-identifier">here?</span>(<span class="ruby-ivar">@uri</span>)
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">DRb</span>.<span class="ruby-identifier">to_obj</span>(<span class="ruby-ivar">@ref</span>)
<span class="ruby-constant">DRb</span>.<span class="ruby-identifier">current_server</span>.<span class="ruby-identifier">check_insecure_method</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-identifier">msg_id</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">__send__</span>(<span class="ruby-identifier">msg_id</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">a</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">succ</span>, <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">with_friend</span>(<span class="ruby-ivar">@uri</span>) <span class="ruby-keyword">do</span>
<span class="ruby-constant">DRbConn</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@uri</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">conn</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">conn</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">msg_id</span>, <span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">succ</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">DRbUnknown</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">result</span>
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">result</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">bt</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">prepare_backtrace</span>(<span class="ruby-ivar">@uri</span>, <span class="ruby-identifier">result</span>)
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">set_backtrace</span>(<span class="ruby-identifier">bt</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">caller</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-identifier">result</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-respond_to-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">respond_to?</span><span
class="method-args">(msg_id, priv=false)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Routes respond_to? to the referenced remote object.</p>
<div class="method-source-code" id="respond_to-3F-source">
<pre><span class="ruby-comment"># File lib/drb/drb.rb, line 1122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">respond_to?</span>(<span class="ruby-identifier">msg_id</span>, <span class="ruby-identifier">priv</span>=<span class="ruby-keyword">false</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">msg_id</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:_dump</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:marshal_dump</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">method_missing</span>(<span class="ruby-value">:respond_to?</span>, <span class="ruby-identifier">msg_id</span>, <span class="ruby-identifier">priv</span>)
<span class="ruby-keyword">end</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>