File: C:/Ruby27-x64/share/doc/ruby/html/DRb/DRbSSLSocket.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class DRb::DRbSSLSocket - 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="DRbTCPSocket.html">DRb::DRbTCPSocket</a>
</div>
<!-- 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-new">::new</a>
<li ><a href="#method-c-open">::open</a>
<li ><a href="#method-c-open_server">::open_server</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-DRb::DRbSSLSocket">
<h1 id="class-DRb::DRbSSLSocket" class="class">
class DRb::DRbSSLSocket
</h1>
<section class="description">
<p>The protocol for <a href="../DRb.html"><code>DRb</code></a> over an SSL socket</p>
<p>The <a href="../URI.html"><code>URI</code></a> for a <a href="../DRb.html"><code>DRb</code></a> socket over SSL is: <code>drbssl://<host>:<port>?<option></code>. The option is optional</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(uri, soc, config, is_established)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create a <a href="DRbSSLSocket.html"><code>DRb::DRbSSLSocket</code></a> instance.</p>
<p><code>uri</code> is the <a href="../URI.html"><code>URI</code></a> we are connected to. <code>soc</code> is the tcp socket we are bound to. <code>config</code> is our configuration. Either a <a href="../Hash.html"><code>Hash</code></a> or <a href="DRbSSLSocket/SSLConfig.html"><code>SSLConfig</code></a> <code>is_established</code> is a boolean of whether <code>soc</code> is currently established</p>
<p>This is called automatically based on the <a href="../DRb.html"><code>DRb</code></a> protocol.</p>
<div class="method-calls-super">
Calls superclass method
<a href="../BasicObject.html#method-c-new"><code>BasicObject::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/drb/ssl.rb, line 304</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">soc</span>, <span class="ruby-identifier">config</span>, <span class="ruby-identifier">is_established</span>)
<span class="ruby-ivar">@ssl</span> = <span class="ruby-identifier">is_established</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">soc</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">soc</span>.<span class="ruby-identifier">to_io</span>, <span class="ruby-identifier">config</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-open" class="method-detail ">
<div class="method-heading">
<span class="method-name">open</span><span
class="method-args">(uri, config)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return an <a href="DRbSSLSocket.html"><code>DRb::DRbSSLSocket</code></a> instance as a client-side connection, with the SSL connected. This is called from <a href="../DRb.html#method-c-start_service"><code>DRb::start_service</code></a> or while connecting to a remote object:</p>
<pre class="ruby"><span class="ruby-constant">DRb</span>.<span class="ruby-identifier">start_service</span> <span class="ruby-string">'drbssl://localhost:0'</span>, <span class="ruby-identifier">front</span>, <span class="ruby-identifier">config</span>
</pre>
<p><code>uri</code> is the <a href="../URI.html"><code>URI</code></a> we are connected to, <code>'drbssl://localhost:0'</code> above, <code>config</code> is our configuration. Either a <a href="../Hash.html"><code>Hash</code></a> or <a href="DRbSSLSocket/SSLConfig.html"><code>DRb::DRbSSLSocket::SSLConfig</code></a></p>
<div class="method-source-code" id="open-source">
<pre><span class="ruby-comment"># File lib/drb/ssl.rb, line 249</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">open</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">config</span>)
<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>, = <span class="ruby-identifier">parse_uri</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-identifier">soc</span> = <span class="ruby-constant">TCPSocket</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>)
<span class="ruby-identifier">ssl_conf</span> = <span class="ruby-constant">SSLConfig</span><span class="ruby-operator">::</span><span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>)
<span class="ruby-identifier">ssl_conf</span>.<span class="ruby-identifier">setup_ssl_context</span>
<span class="ruby-identifier">ssl</span> = <span class="ruby-identifier">ssl_conf</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-identifier">soc</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">ssl</span>, <span class="ruby-identifier">ssl_conf</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-open_server" class="method-detail ">
<div class="method-heading">
<span class="method-name">open_server</span><span
class="method-args">(uri, config)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns a <a href="DRbSSLSocket.html"><code>DRb::DRbSSLSocket</code></a> instance as a server-side connection, with the SSL connected. This is called from <a href="../DRb.html#method-c-start_service"><code>DRb::start_service</code></a> or while connecting to a remote object:</p>
<pre class="ruby"><span class="ruby-constant">DRb</span>.<span class="ruby-identifier">start_service</span> <span class="ruby-string">'drbssl://localhost:0'</span>, <span class="ruby-identifier">front</span>, <span class="ruby-identifier">config</span>
</pre>
<p><code>uri</code> is the <a href="../URI.html"><code>URI</code></a> we are connected to, <code>'drbssl://localhost:0'</code> above, <code>config</code> is our configuration. Either a <a href="../Hash.html"><code>Hash</code></a> or <a href="DRbSSLSocket/SSLConfig.html"><code>DRb::DRbSSLSocket::SSLConfig</code></a></p>
<div class="method-source-code" id="open_server-source">
<pre><span class="ruby-comment"># File lib/drb/ssl.rb, line 267</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">open_server</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">config</span>)
<span class="ruby-identifier">uri</span> = <span class="ruby-string">'drbssl://:0'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</span>
<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>, = <span class="ruby-identifier">parse_uri</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">host</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">host</span> = <span class="ruby-identifier">getservername</span>
<span class="ruby-identifier">soc</span> = <span class="ruby-identifier">open_server_inaddr_any</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">soc</span> = <span class="ruby-constant">TCPServer</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">port</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">port</span> = <span class="ruby-identifier">soc</span>.<span class="ruby-identifier">addr</span>[<span class="ruby-value">1</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">port</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-ivar">@uri</span> = <span class="ruby-node">"drbssl://#{host}:#{port}"</span>
<span class="ruby-identifier">ssl_conf</span> = <span class="ruby-constant">SSLConfig</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>)
<span class="ruby-identifier">ssl_conf</span>.<span class="ruby-identifier">setup_certificate</span>
<span class="ruby-identifier">ssl_conf</span>.<span class="ruby-identifier">setup_ssl_context</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@uri</span>, <span class="ruby-identifier">soc</span>, <span class="ruby-identifier">ssl_conf</span>, <span class="ruby-keyword">false</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>