mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
283 lines
19 KiB
HTML
283 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class Addrinfo - 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-parse">::parse</a>
|
|
|
|
<li ><a href="#method-i-uri_info">#uri_info</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-Addrinfo">
|
|
<h1 id="class-Addrinfo" class="class">
|
|
class Addrinfo
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</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-parse" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">parse</span><span
|
|
class="method-args">(*args)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="parse-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 1752</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">parse</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-comment"># Attempts to create an address object for the given URI/URL</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">Generic</span>)
|
|
<span class="ruby-identifier">raw_uri</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raw_uri</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">the_protocol</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">the_port</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-identifier">service_details</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">SYSTEM</span>.<span class="ruby-identifier">service_ports_search</span>({<span class="ruby-value">:scheme</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">scheme</span>()})
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">service_details</span>.<span class="ruby-identifier">keys</span>().<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">service_details</span> = <span class="ruby-identifier">service_details</span>[(<span class="ruby-identifier">service_details</span>.<span class="ruby-identifier">keys</span>()[<span class="ruby-value">0</span>])]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage_preference</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage</span>][(<span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage_preference</span>])].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
|
<span class="ruby-identifier">the_port</span> = <span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage</span>][(<span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage_preference</span>])][<span class="ruby-value">0</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_port</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Range</span>)
|
|
<span class="ruby-identifier">the_protocol</span> = (<span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage_preference</span>])
|
|
<span class="ruby-identifier">the_port</span> = <span class="ruby-identifier">the_port</span>.<span class="ruby-identifier">first</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage</span>][(<span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage</span>].<span class="ruby-identifier">keys</span>()[<span class="ruby-value">0</span>])].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
|
<span class="ruby-identifier">the_port</span> = <span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage</span>][(<span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage</span>].<span class="ruby-identifier">keys</span>()[<span class="ruby-value">0</span>])][<span class="ruby-value">0</span>]
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_port</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Range</span>)
|
|
<span class="ruby-identifier">the_protocol</span> = (<span class="ruby-identifier">service_details</span>[<span class="ruby-value">:usage</span>].<span class="ruby-identifier">keys</span>()[<span class="ruby-value">0</span>])
|
|
<span class="ruby-identifier">the_port</span> = <span class="ruby-identifier">the_port</span>.<span class="ruby-identifier">first</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_protocol</span>
|
|
<span class="ruby-identifier">the_protocol</span> = <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">scheme</span>().<span class="ruby-identifier">to_sym</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">case</span> <span class="ruby-identifier">the_protocol</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:inproc</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:ipc</span>
|
|
<span class="ruby-comment"># LATER: Anything to be done for IPC stuff here??? (Not available on winderz)</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:pgm</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:epgm</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:unix</span>, <span class="ruby-value">:socket</span>
|
|
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">hostname</span>().<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>)
|
|
<span class="ruby-comment"># Unix socket</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span>.<span class="ruby-identifier">unix</span>(<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">path</span>())
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-comment"># tcp used by default for ipc</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">hostname</span>().<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span>.<span class="ruby-identifier">tcp</span>(<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">hostname</span>(), (<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">default_port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">the_port</span> <span class="ruby-operator">||</span> <span class="ruby-string">"*"</span>))
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span>.<span class="ruby-identifier">tcp</span>(<span class="ruby-string">"0.0.0.0"</span>, (<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">default_port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">the_port</span> <span class="ruby-operator">||</span> <span class="ruby-string">"*"</span>))
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:tcp</span>, <span class="ruby-value">:tcp4</span>, <span class="ruby-value">:tcp6</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">hostname</span>().<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span>.<span class="ruby-identifier">tcp</span>(<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">hostname</span>(), (<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">default_port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">the_port</span> <span class="ruby-operator">||</span> <span class="ruby-string">"*"</span>))
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span>.<span class="ruby-identifier">tcp</span>(<span class="ruby-string">"0.0.0.0"</span>, (<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">default_port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">the_port</span> <span class="ruby-operator">||</span> <span class="ruby-string">"*"</span>))
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-value">:udp</span>, <span class="ruby-value">:udp4</span>, <span class="ruby-value">:udp6</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">hostname</span>().<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span>.<span class="ruby-identifier">udp</span>(<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">hostname</span>(), (<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">default_port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">the_port</span> <span class="ruby-operator">||</span> <span class="ruby-string">"*"</span>))
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">address</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span>.<span class="ruby-identifier">udp</span>(<span class="ruby-string">"0.0.0.0"</span>, (<span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_uri</span>.<span class="ruby-identifier">default_port</span>() <span class="ruby-operator">||</span> <span class="ruby-identifier">the_port</span> <span class="ruby-operator">||</span> <span class="ruby-string">"*"</span>))
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">address</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-uri_info" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">uri_info</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="uri_info-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 1826</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uri_info</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">ip?</span>()
|
|
<span class="ruby-keyword">case</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">protocol</span>
|
|
<span class="ruby-keyword">when</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_TCP</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-node">"tcp://#{self.ip_address()}:#{(self.ip_port() || '*')}"</span>)
|
|
<span class="ruby-keyword">when</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_UDP</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-node">"udp://#{self.ip_address()}:#{(self.ip_port() || '*')}"</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">unix?</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-node">"unix://#{self.unix_path()}"</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-comment"># not sure what to do here</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</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.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|