File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Settings/Mirror.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Settings::Mirror - 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-new">::new</a>
<li ><a href="#method-i-3D-3D">#==</a>
<li ><a href="#method-i-fallback_timeout-3D">#fallback_timeout=</a>
<li ><a href="#method-i-uri-3D">#uri=</a>
<li ><a href="#method-i-valid-3F">#valid?</a>
<li ><a href="#method-i-validate-21">#validate!</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Settings::Mirror">
<h1 id="class-Bundler::Settings::Mirror" class="class">
class Bundler::Settings::Mirror
</h1>
<section class="description">
<p>A mirror</p>
<p>Contains both the uri that should be used as a mirror and the</p>
<pre>fallback timeout which will be used for probing if the mirror
replies on time or not.</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="DEFAULT_FALLBACK_TIMEOUT">DEFAULT_FALLBACK_TIMEOUT
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-fallback_timeout" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">fallback_timeout</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
<div id="attribute-i-uri" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">uri</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
</div>
</div>
</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 = nil, fallback_timeout = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/bundler/mirror.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">uri</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">fallback_timeout</span> = <span class="ruby-value">0</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">uri</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">fallback_timeout</span> = <span class="ruby-identifier">fallback_timeout</span>
<span class="ruby-ivar">@valid</span> = <span class="ruby-keyword">nil</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-3D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">==</span><span
class="method-args">(other)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="3D-3D-source">
<pre><span class="ruby-comment"># File lib/bundler/mirror.rb, line 94</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>)
<span class="ruby-operator">!</span><span class="ruby-identifier">other</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">uri</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">uri</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">fallback_timeout</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">fallback_timeout</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fallback_timeout-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">fallback_timeout=</span><span
class="method-args">(timeout)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="fallback_timeout-3D-source">
<pre><span class="ruby-comment"># File lib/bundler/mirror.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fallback_timeout=</span>(<span class="ruby-identifier">timeout</span>)
<span class="ruby-keyword">case</span> <span class="ruby-identifier">timeout</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">true</span>, <span class="ruby-string">"true"</span>
<span class="ruby-ivar">@fallback_timeout</span> = <span class="ruby-constant">DEFAULT_FALLBACK_TIMEOUT</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">false</span>, <span class="ruby-string">"false"</span>
<span class="ruby-ivar">@fallback_timeout</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@fallback_timeout</span> = <span class="ruby-identifier">timeout</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@valid</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-uri-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">uri=</span><span
class="method-args">(uri)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="uri-3D-source">
<pre><span class="ruby-comment"># File lib/bundler/mirror.rb, line 73</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uri=</span>(<span class="ruby-identifier">uri</span>)
<span class="ruby-ivar">@uri</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-constant">Bundler</span><span class="ruby-operator">::</span><span class="ruby-constant">URI</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@valid</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-valid-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid?</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="valid-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/mirror.rb, line 98</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">valid?</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@uri</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@valid</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@valid</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-validate-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">validate!</span><span
class="method-args">(probe = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="validate-21-source">
<pre><span class="ruby-comment"># File lib/bundler/mirror.rb, line 104</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">validate!</span>(<span class="ruby-identifier">probe</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@valid</span> = <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@valid</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@valid</span> = <span class="ruby-identifier">fallback_timeout</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">probe</span> <span class="ruby-operator">||</span> <span class="ruby-constant">TCPSocketProbe</span>.<span class="ruby-identifier">new</span>).<span class="ruby-identifier">replies?</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">self</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>