File: C:/Ruby27-x64/share/doc/ruby/html/ACL/ACLEntry.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class ACL::ACLEntry - 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-dot_pat">#dot_pat</a>
<li ><a href="#method-i-dot_pat_str">#dot_pat_str</a>
<li ><a href="#method-i-match">#match</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-ACL::ACLEntry">
<h1 id="class-ACL::ACLEntry" class="class">
class ACL::ACLEntry
</h1>
<section class="description">
<p>An entry in an <a href="../ACL.html"><code>ACL</code></a></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">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new entry using <code>str</code>.</p>
<p><code>str</code> may be “*” or “all” to match any address, an IP address string to match a specific address, an IP address mask per <a href="../IPAddr.html"><code>IPAddr</code></a>, or one containing “*” to match part of an IPv4 address.</p>
<p><a href="../IPAddr/InvalidPrefixError.html"><code>IPAddr::InvalidPrefixError</code></a> may be raised when an IP network address with an invalid netmask/prefix is given.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">==</span> <span class="ruby-string">'*'</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">str</span> <span class="ruby-operator">==</span> <span class="ruby-string">'all'</span>
<span class="ruby-ivar">@pat</span> = [<span class="ruby-value">:all</span>]
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">'*'</span>)
<span class="ruby-ivar">@pat</span> = [<span class="ruby-value">:name</span>, <span class="ruby-identifier">dot_pat</span>(<span class="ruby-identifier">str</span>)]
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@pat</span> = [<span class="ruby-value">:ip</span>, <span class="ruby-constant">IPAddr</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">str</span>)]
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">IPAddr</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidPrefixError</span>
<span class="ruby-comment"># In this case, `str` shouldn't be a host name pattern</span>
<span class="ruby-comment"># because it contains a slash.</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">ArgumentError</span>
<span class="ruby-ivar">@pat</span> = [<span class="ruby-value">:name</span>, <span class="ruby-identifier">dot_pat</span>(<span class="ruby-identifier">str</span>)]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</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-match" class="method-detail ">
<div class="method-heading">
<span class="method-name">match</span><span
class="method-args">(addr)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Matches <code>addr</code> against this entry.</p>
<div class="method-source-code" id="match-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 100</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match</span>(<span class="ruby-identifier">addr</span>)
<span class="ruby-keyword">case</span> <span class="ruby-ivar">@pat</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">when</span> <span class="ruby-value">:all</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:ip</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">ipaddr</span> = <span class="ruby-constant">IPAddr</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">addr</span>[<span class="ruby-value">3</span>])
<span class="ruby-identifier">ipaddr</span> = <span class="ruby-identifier">ipaddr</span>.<span class="ruby-identifier">ipv4_mapped</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@pat</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">ipv6?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">ipaddr</span>.<span class="ruby-identifier">ipv4?</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">ArgumentError</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
(<span class="ruby-ivar">@pat</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">ipaddr</span>)) <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:name</span>
(<span class="ruby-ivar">@pat</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">=~</span> <span class="ruby-identifier">addr</span>[<span class="ruby-value">2</span>]) <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-dot_pat" class="method-detail ">
<div class="method-heading">
<span class="method-name">dot_pat</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a <a href="../Regexp.html"><code>Regexp</code></a> to match an address.</p>
<div class="method-source-code" id="dot_pat-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 91</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dot_pat</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-regexp">/\A#{dot_pat_str(str)}\z/</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dot_pat_str" class="method-detail ">
<div class="method-heading">
<span class="method-name">dot_pat_str</span><span
class="method-args">(str)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a regular expression to match IPv4 addresses</p>
<div class="method-source-code" id="dot_pat_str-source">
<pre><span class="ruby-comment"># File lib/drb/acl.rb, line 79</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dot_pat_str</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">list</span> = <span class="ruby-identifier">str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'.'</span>).<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
(<span class="ruby-identifier">s</span> <span class="ruby-operator">==</span> <span class="ruby-string">'*'</span>) <span class="ruby-operator">?</span> <span class="ruby-string">'.+'</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">s</span>
}
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\\."</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>