mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-10-19 04:49:44 -07:00
Initial Commit
This commit is contained in:
G. Gibson
parent
3215e21a8a
commit
4bb9f2f2ea
189 changed files with 135079 additions and 2 deletions
31
LICENSE.txt
Normal file
31
LICENSE.txt
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
GxG Framework Copyright (2021) (COPYRIGHT G. GIBSON)(“Licensor”)
|
||||
|
||||
Hippocratic License Version Number: 2.1.
|
||||
|
||||
Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
|
||||
|
||||
Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
|
||||
|
||||
Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
|
||||
|
||||
Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
|
||||
|
||||
Compliance with Human Rights Principles and Human Rights Laws.
|
||||
|
||||
Human Rights Principles.
|
||||
|
||||
(a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
|
||||
|
||||
(b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
|
||||
|
||||
Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal’s powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
|
||||
|
||||
Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws. “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above). Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
|
||||
|
||||
Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
|
||||
|
||||
Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
|
||||
|
||||
Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
|
||||
|
||||
Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
|
||||
11
README.md
11
README.md
|
|
@ -1,2 +1,9 @@
|
|||
# gxg-framework
|
||||
GxG Framework
|
||||
GxG Framework for JRuby
|
||||
|
||||
Building:
|
||||
|
||||
jgem build ./gxg-framework.gemspec
|
||||
|
||||
Installation:
|
||||
|
||||
sudo jgem install GEMFILE
|
||||
|
|
|
|||
283
doc/Addrinfo.html
Normal file
283
doc/Addrinfo.html
Normal file
|
|
@ -0,0 +1,283 @@
|
|||
<!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>
|
||||
|
||||
868
doc/Array.html
Normal file
868
doc/Array.html
Normal file
|
|
@ -0,0 +1,868 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Array - 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-gxg_import">::gxg_import</a>
|
||||
|
||||
<li ><a href="#method-c-process">::process</a>
|
||||
|
||||
<li ><a href="#method-c-search">::search</a>
|
||||
|
||||
<li ><a href="#method-i-average">#average</a>
|
||||
|
||||
<li ><a href="#method-i-get_at_path">#get_at_path</a>
|
||||
|
||||
<li ><a href="#method-i-gxg_export">#gxg_export</a>
|
||||
|
||||
<li ><a href="#method-i-iterative">#iterative</a>
|
||||
|
||||
<li ><a href="#method-i-paths_to">#paths_to</a>
|
||||
|
||||
<li ><a href="#method-i-process">#process</a>
|
||||
|
||||
<li ><a href="#method-i-process-21">#process!</a>
|
||||
|
||||
<li ><a href="#method-i-search">#search</a>
|
||||
|
||||
<li ><a href="#method-i-set_at_path">#set_at_path</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Array">
|
||||
<h1 id="class-Array" class="class">
|
||||
class Array
|
||||
</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-gxg_import" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">gxg_import</span><span
|
||||
class="method-args">(the_exported_record=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="gxg_import-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3997</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">gxg_import</span>(<span class="ruby-identifier">the_exported_record</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_exported_record</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_exported_record</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"Hash"</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Hash</span><span class="ruby-operator">::</span><span class="ruby-identifier">gxg_import</span>(<span class="ruby-identifier">the_exported_record</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">import_value</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">type</span>,<span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-identifier">the_class</span> = <span class="ruby-identifier">eval</span>(<span class="ruby-identifier">type</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_class</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:parse</span>)
|
||||
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">the_class</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">value</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_class</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:new</span>)
|
||||
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">the_class</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">value</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_class</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:try_convert</span>)
|
||||
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">the_class</span>.<span class="ruby-identifier">try_convert</span>(<span class="ruby-identifier">value</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_exported_record</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"Array"</span>
|
||||
<span class="ruby-identifier">result</span> = []
|
||||
<span class="ruby-identifier">import_db</span> = [{<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">result</span>, <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_exported_record</span>}]
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">import_db</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">import_db</span>.<span class="ruby-identifier">shift</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:record</span>][<span class="ruby-value">:content</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:record</span>][<span class="ruby-value">:content</span>].<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">selector</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"Hash"</span>
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)] = {}
|
||||
<span class="ruby-identifier">import_db</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>], <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">selector</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)], <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"Array"</span>
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)] = []
|
||||
<span class="ruby-identifier">import_db</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>], <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">selector</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)], <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)] = <span class="ruby-identifier">import_value</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">value</span>[<span class="ruby-value">:type</span>], <span class="ruby-identifier">value</span>[<span class="ruby-value">:content</span>])
|
||||
<span class="ruby-keyword">end</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">entry</span>[<span class="ruby-value">:record</span>][<span class="ruby-value">:content</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:record</span>][<span class="ruby-value">:content</span>].<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">selector</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"Hash"</span>
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)] = {}
|
||||
<span class="ruby-identifier">import_db</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>], <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">selector</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)], <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"Array"</span>
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)] = []
|
||||
<span class="ruby-identifier">import_db</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>], <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">selector</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)], <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">value</span>}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>][(<span class="ruby-identifier">selector</span>)] = <span class="ruby-identifier">import_value</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">value</span>[<span class="ruby-value">:type</span>], <span class="ruby-identifier">value</span>[<span class="ruby-value">:content</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">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">import_value</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">the_exported_record</span>[<span class="ruby-value">:type</span>], <span class="ruby-identifier">the_exported_record</span>[<span class="ruby-value">:content</span>])
|
||||
<span class="ruby-keyword">end</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>
|
||||
|
||||
|
||||
<div id="method-c-process" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process</span><span
|
||||
class="method-args">(the_array=[],&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Interesting research on extending ruby classes '|' for instance: <a href="http://verboselogging.com/2011/05/06/simple-ruby-pipes">verboselogging.com/2011/05/06/simple-ruby-pipes</a> Also: <a href="http://stackoverflow.com/questions/4234119/ruby-pipes-how-do-i-tie-the-output-of-two-subprocesses-together">stackoverflow.com/questions/4234119/ruby-pipes-how-do-i-tie-the-output-of-two-subprocesses-together</a> And a <strong>really</strong> nice one: <a href="http://jstorimer.com/2012/03/18/a-unix-shell-in-ruby-pipes.html#Shell%20Pipelines%20Demystified">jstorimer.com/2012/03/18/a-unix-shell-in-ruby-pipes.html#Shell%20Pipelines%20Demystified</a></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3704</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">process</span>(<span class="ruby-identifier">the_array</span>=[],<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">new_array</span> = []
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_array</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedHash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedArray</span>)
|
||||
<span class="ruby-identifier">new_array</span> = <span class="ruby-identifier">the_array</span>.<span class="ruby-identifier">process</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you must pass a Array, a Hash, or a ByteArray"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">new_array</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-search" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">search</span><span
|
||||
class="method-args">(the_array=[],&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="search-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3716</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">search</span>(<span class="ruby-identifier">the_array</span>=[],<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">new_array</span> = []
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_array</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedHash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedArray</span>)
|
||||
<span class="ruby-identifier">new_array</span> = <span class="ruby-identifier">the_array</span>.<span class="ruby-identifier">search</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you must pass a Array, a Hash, or a ByteArray"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">new_array</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-average" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">average</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="average-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 4068</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">average</span>()
|
||||
<span class="ruby-comment"># See: https://stackoverflow.com/questions/1341271/how-do-i-create-an-average-from-a-ruby-array</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_eval</span> { <span class="ruby-identifier">reduce</span>(<span class="ruby-value">:+</span>).<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">size</span>.<span class="ruby-identifier">to_f</span> }
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-get_at_path" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get_at_path</span><span
|
||||
class="method-args">(the_path="/")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="get_at_path-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3880</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_at_path</span>(<span class="ruby-identifier">the_path</span>=<span class="ruby-string">"/"</span>)
|
||||
<span class="ruby-comment"># /^(?:[0-9])*[0-9](?:[0-9])*$/ = nil if an alpha present there, else 0 only numeric</span>
|
||||
<span class="ruby-comment"># Attribution : http://stackoverflow.com/questions/1240674/regex-match-a-string-containing-numbers-and-letters-but-not-a-string-of-just-nu</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment"># if ":" detected do: (str.gsub("%2f","/").to_sym) as key else (str.gsub("%2f","/"))</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_path</span> <span class="ruby-operator">==</span> <span class="ruby-string">"/"</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">object_stack</span> = [(<span class="ruby-keyword">self</span>)]
|
||||
<span class="ruby-identifier">path_stack</span> = <span class="ruby-identifier">the_path</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>)
|
||||
<span class="ruby-identifier">path_stack</span>.<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path_element</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">element</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">path_element</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">path_element</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^(?:[0-9])*[0-9](?:[0-9])*$/</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">element</span> = <span class="ruby-identifier">path_element</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">element</span> = <span class="ruby-identifier">path_element</span>
|
||||
<span class="ruby-identifier">element</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">"%2f"</span>,<span class="ruby-string">"/"</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">element</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">":"</span>
|
||||
<span class="ruby-identifier">element</span> = <span class="ruby-identifier">element</span>[(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)].<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">element</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">object_stack</span>.<span class="ruby-identifier">first</span>[(<span class="ruby-identifier">element</span>)]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">NilClass</span>)
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">object_stack</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">result</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># ignore double slashes? '//'</span>
|
||||
<span class="ruby-comment"># break</span>
|
||||
<span class="ruby-keyword">end</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>
|
||||
|
||||
|
||||
<div id="method-i-gxg_export" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">gxg_export</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="gxg_export-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3951</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gxg_export</span>()
|
||||
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Array"</span>, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> []}
|
||||
<span class="ruby-identifier">export_db</span> = [{<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>, <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">result</span>}]
|
||||
<span class="ruby-identifier">children_of</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_parent</span>=<span class="ruby-keyword">nil</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">list</span> = []
|
||||
<span class="ruby-identifier">export_db</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span>[<span class="ruby-value">:parent</span>].<span class="ruby-identifier">object_id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">the_parent</span>.<span class="ruby-identifier">object_id</span>
|
||||
<span class="ruby-identifier">list</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">node</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">list</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">export_record</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-constant">Integer</span>, <span class="ruby-constant">Float</span>, <span class="ruby-constant">String</span>)
|
||||
{<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>}
|
||||
<span class="ruby-keyword">else</span>
|
||||
{<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">to_s</span>}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Build up export_db:</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">search</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_value</span>, <span class="ruby-identifier">the_selector</span>, <span class="ruby-identifier">the_container</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">export_db</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_container</span>, <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_selector</span>.<span class="ruby-identifier">clone</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>, <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Hash"</span>, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> {}}}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">export_db</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_container</span>, <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_selector</span>.<span class="ruby-identifier">clone</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>, <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Array"</span>, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> []}}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">export_db</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_container</span>, <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_selector</span>.<span class="ruby-identifier">clone</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>, <span class="ruby-value">:record</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">export_record</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">the_value</span>)}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Collect children export content:</span>
|
||||
<span class="ruby-identifier">link_db</span> =[(<span class="ruby-identifier">export_db</span>[<span class="ruby-value">0</span>])]
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">link_db</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">link_db</span>.<span class="ruby-identifier">shift</span>
|
||||
<span class="ruby-identifier">children_of</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>]).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_child</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">entry</span>[<span class="ruby-value">:record</span>][<span class="ruby-value">:content</span>][(<span class="ruby-identifier">the_child</span>[<span class="ruby-value">:parent_selector</span>])] = <span class="ruby-identifier">the_child</span>[<span class="ruby-value">:record</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_child</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-constant">Hash</span>, <span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">link_db</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_child</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-iterative" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">iterative</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="iterative-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3728</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">iterative</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = []
|
||||
<span class="ruby-identifier">visit</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_node</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">accumulator</span>=[]<span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">node_stack</span> = []
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_node</span>
|
||||
<span class="ruby-identifier">node_stack</span> <span class="ruby-operator"><<</span> ({<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_node</span>)})
|
||||
<span class="ruby-keyword">while</span> (<span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-identifier">a_node</span> = <span class="ruby-identifier">node_stack</span>.<span class="ruby-identifier">shift</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">a_node</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedHash</span>)
|
||||
<span class="ruby-identifier">a_node</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">node_stack</span> <span class="ruby-operator"><<</span> ({<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">a_node</span>[<span class="ruby-value">:object</span>], <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_key</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">a_node</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedArray</span>)
|
||||
<span class="ruby-identifier">a_node</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_value</span>, <span class="ruby-identifier">the_index</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">node_stack</span> <span class="ruby-operator"><<</span> ({<span class="ruby-value">:parent</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">a_node</span>[<span class="ruby-value">:object</span>], <span class="ruby-value">:parent_selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_index</span>, <span class="ruby-value">:object</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">a_node</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">accumulator</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">children_of</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_db</span>=[], <span class="ruby-identifier">the_parent</span>=<span class="ruby-keyword">nil</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">list</span> = []
|
||||
<span class="ruby-identifier">the_db</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span>[<span class="ruby-value">:parent</span>].<span class="ruby-identifier">object_id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">the_parent</span>.<span class="ruby-identifier">object_id</span>
|
||||
<span class="ruby-identifier">list</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">node</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">list</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-identifier">database</span> = <span class="ruby-identifier">visit</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>,[])
|
||||
<span class="ruby-identifier">link_db</span> = <span class="ruby-identifier">children_of</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">database</span>, <span class="ruby-keyword">self</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-keyword">while</span> (<span class="ruby-identifier">link_db</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">link_db</span>.<span class="ruby-identifier">shift</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">object_id</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">object_id</span>
|
||||
<span class="ruby-comment"># calls with parameters: the_value, the_key/the_index (the_selector), the_container</span>
|
||||
<span class="ruby-identifier">raw_result</span> = <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>], <span class="ruby-identifier">entry</span>[<span class="ruby-value">:parent_selector</span>], <span class="ruby-identifier">entry</span>[<span class="ruby-value">:parent</span>])
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_result</span>
|
||||
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">raw_result</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">object_id</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>.<span class="ruby-identifier">object_id</span>
|
||||
<span class="ruby-identifier">children</span> = <span class="ruby-identifier">children_of</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">database</span>, <span class="ruby-identifier">entry</span>[<span class="ruby-value">:object</span>])
|
||||
<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">link_db</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">child</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-comment">#</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-paths_to" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">paths_to</span><span
|
||||
class="method-args">(the_object=nil,base_path="")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="paths_to-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3813</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">paths_to</span>(<span class="ruby-identifier">the_object</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">base_path</span>=<span class="ruby-string">""</span>)
|
||||
<span class="ruby-comment"># new idea here:</span>
|
||||
<span class="ruby-identifier">search_results</span> = []
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">base_path</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"/"</span>
|
||||
<span class="ruby-identifier">base_path</span> = (<span class="ruby-string">"/"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">base_path</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">base_path</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">path_stack</span> = <span class="ruby-identifier">base_path</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>)[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>].<span class="ruby-identifier">reverse</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">path_stack</span> = []
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">origin</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">get_at_path</span>(<span class="ruby-identifier">base_path</span>)
|
||||
<span class="ruby-identifier">container_stack</span> = [{<span class="ruby-value">:selector</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:container</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">origin</span>}]
|
||||
<span class="ruby-identifier">find_container</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_container</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">container_stack</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>[<span class="ruby-value">:container</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">the_container</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">entry</span>
|
||||
<span class="ruby-keyword">break</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>
|
||||
<span class="ruby-identifier">last_container</span> = <span class="ruby-identifier">origin</span>
|
||||
<span class="ruby-identifier">found</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-comment"># tester = {:a=>1, :b=>2, :c=>[0, 5], :testing=>{:d=>4.0, :e=>0.9, :f => nil}}</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">origin</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedHash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedArray</span>)
|
||||
<span class="ruby-identifier">origin</span>.<span class="ruby-identifier">process!</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_value</span>, <span class="ruby-identifier">selector</span>, <span class="ruby-identifier">container</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">last_container</span>.<span class="ruby-identifier">object_id</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">container</span>.<span class="ruby-identifier">object_id</span>
|
||||
<span class="ruby-identifier">container_record</span> = <span class="ruby-identifier">find_container</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">container</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">container_record</span>
|
||||
<span class="ruby-identifier">path_stack</span> = <span class="ruby-identifier">container_record</span>[<span class="ruby-value">:prefix</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">reverse</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">path_stack</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">path_stack</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-identifier">last_container</span> = <span class="ruby-identifier">container</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">selector</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-identifier">safe_key</span> = (<span class="ruby-string">":"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">selector</span>.<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">safe_key</span> = <span class="ruby-identifier">selector</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">safe_key</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">"/"</span>,<span class="ruby-string">"%2f"</span>)
|
||||
<span class="ruby-identifier">path_stack</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-identifier">safe_key</span>)
|
||||
<span class="ruby-comment"># compare the_value</span>
|
||||
<span class="ruby-identifier">found</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_value</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">the_object</span>)
|
||||
<span class="ruby-identifier">found</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">found</span>
|
||||
<span class="ruby-identifier">search_results</span> <span class="ruby-operator"><<</span> (<span class="ruby-string">"/"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">path_stack</span>.<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"/"</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedHash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedArray</span>)
|
||||
<span class="ruby-identifier">container_stack</span>.<span class="ruby-identifier">unshift</span>({<span class="ruby-value">:selector</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">selector</span>, <span class="ruby-value">:container</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_value</span>, <span class="ruby-value">:prefix</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">path_stack</span>.<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"/"</span>))})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">path_stack</span>.<span class="ruby-identifier">shift</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">search_results</span> <span class="ruby-operator"><<</span> (<span class="ruby-string">"/"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">path_stack</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"/"</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">search_results</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3793</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">iterative</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process-21" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process!</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process-21-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3799</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">iterative</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-search" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">search</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="search-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3804</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">results</span> = []
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">results</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">iterative</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">results</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-set_at_path" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">set_at_path</span><span
|
||||
class="method-args">(the_path="/",the_value=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="set_at_path-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 3920</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_at_path</span>(<span class="ruby-identifier">the_path</span>=<span class="ruby-string">"/"</span>,<span class="ruby-identifier">the_value</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_path</span> <span class="ruby-operator">!=</span> <span class="ruby-string">"/"</span>
|
||||
<span class="ruby-identifier">container</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">get_at_path</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">the_path</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">container</span>
|
||||
<span class="ruby-identifier">raw_selector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">basename</span>(<span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-identifier">selector</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_selector</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_selector</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^(?:[0-9])*[0-9](?:[0-9])*$/</span>) <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">selector</span> = <span class="ruby-identifier">raw_selector</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">selector</span> = <span class="ruby-identifier">raw_selector</span>
|
||||
<span class="ruby-identifier">selector</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">"%2f"</span>,<span class="ruby-string">"/"</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">selector</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">":"</span>
|
||||
<span class="ruby-identifier">selector</span> = <span class="ruby-identifier">selector</span>[(<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)].<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">selector</span>
|
||||
<span class="ruby-identifier">container</span>[(<span class="ruby-identifier">selector</span>)] = <span class="ruby-identifier">the_value</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">container</span>[(<span class="ruby-identifier">selector</span>)]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># ignore double slashes? '//'</span>
|
||||
<span class="ruby-comment"># break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</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>
|
||||
|
||||
99
doc/Blather.html
Normal file
99
doc/Blather.html
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module Blather - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-Blather">
|
||||
<h1 id="module-Blather" class="module">
|
||||
module Blather
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>### <a href="Blather/MUC.html"><code>MUC</code></a> extentions for Blather: See: <a href="https://github.com/maccman/blather">github.com/maccman/blather</a> and <a href="https://github.com/adhearsion/blather/issues/81">github.com/adhearsion/blather/issues/81</a></p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
158
doc/Blather/Client.html
Normal file
158
doc/Blather/Client.html
Normal file
|
|
@ -0,0 +1,158 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::Client - 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-i-unbind">#unbind</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::Client">
|
||||
<h1 id="class-Blather::Client" class="class">
|
||||
class Blather::Client
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-unbind" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">unbind</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="unbind-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 37</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unbind</span>
|
||||
<span class="ruby-comment"># Fix bug where closing connection stops EM for ALL Client Instances.</span>
|
||||
<span class="ruby-comment"># call_handler_for(:disconnected, nil) || (EM.reactor_running? && EM.stop)</span>
|
||||
<span class="ruby-identifier">call_handler_for</span>(<span class="ruby-value">:disconnected</span>, <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
97
doc/Blather/DSL.html
Normal file
97
doc/Blather/DSL.html
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module Blather::DSL - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-Blather::DSL">
|
||||
<h1 id="module-Blather::DSL" class="module">
|
||||
module Blather::DSL
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
809
doc/Blather/DSL/MultiUserChat.html
Normal file
809
doc/Blather/DSL/MultiUserChat.html
Normal file
|
|
@ -0,0 +1,809 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::DSL::MultiUserChat - 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-configuration">#configuration</a>
|
||||
|
||||
<li ><a href="#method-i-configuration-3D">#configuration=</a>
|
||||
|
||||
<li ><a href="#method-i-destroy">#destroy</a>
|
||||
|
||||
<li ><a href="#method-i-get_configuration">#get_configuration</a>
|
||||
|
||||
<li ><a href="#method-i-invite">#invite</a>
|
||||
|
||||
<li ><a href="#method-i-join">#join</a>
|
||||
|
||||
<li ><a href="#method-i-leave">#leave</a>
|
||||
|
||||
<li ><a href="#method-i-members">#members</a>
|
||||
|
||||
<li ><a href="#method-i-say">#say</a>
|
||||
|
||||
<li ><a href="#method-i-set_configuration">#set_configuration</a>
|
||||
|
||||
<li ><a href="#method-i-set_default_configuration">#set_default_configuration</a>
|
||||
|
||||
<li ><a href="#method-i-status-3D">#status=</a>
|
||||
|
||||
<li ><a href="#method-i-subject-3D">#subject=</a>
|
||||
|
||||
<li ><a href="#method-i-unlock">#unlock</a>
|
||||
|
||||
<li ><a href="#method-i-write">#write</a>
|
||||
|
||||
<li ><a href="#method-i-write_with_handler">#write_with_handler</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::DSL::MultiUserChat">
|
||||
<h1 id="class-Blather::DSL::MultiUserChat" class="class">
|
||||
class Blather::DSL::MultiUserChat
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(client, jid, nickname = nil, password = nil)</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/gxg/net_clients.rb, line 47</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">client</span>, <span class="ruby-identifier">jid</span>, <span class="ruby-identifier">nickname</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-identifier">client</span>
|
||||
<span class="ruby-ivar">@room</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">jid</span>)
|
||||
<span class="ruby-ivar">@nickname</span> = <span class="ruby-identifier">nickname</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@room</span>.<span class="ruby-identifier">resource</span>
|
||||
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
|
||||
<span class="ruby-ivar">@room</span>.<span class="ruby-identifier">strip!</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-configuration" class="method-detail method-alias">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">configuration</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Alias for: <a href="MultiUserChat.html#method-i-get_configuration">get_configuration</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-configuration-3D" class="method-detail method-alias">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">configuration=</span><span
|
||||
class="method-args">(values, &block)</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Alias for: <a href="MultiUserChat.html#method-i-set_configuration">set_configuration</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-destroy" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">destroy</span><span
|
||||
class="method-args">(reason = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p><iq from='crone1@shakespeare.lit/desktop'</p>
|
||||
|
||||
<pre> id='begone'
|
||||
to='heath@chat.shakespeare.lit'
|
||||
type='set'>
|
||||
<query xmlns='http://jabber.org/protocol/muc#owner'>
|
||||
<destroy jid='darkcave@chat.shakespeare.lit'>
|
||||
<reason>Macbeth doth come.</reason>
|
||||
</destroy>
|
||||
</query></pre>
|
||||
|
||||
<p></iq></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="destroy-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 120</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">destroy</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">destroy</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Owner</span><span class="ruby-operator">::</span><span class="ruby-constant">Destroy</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>)
|
||||
|
||||
<span class="ruby-identifier">destroy</span>.<span class="ruby-identifier">reason</span> = <span class="ruby-identifier">reason</span>
|
||||
<span class="ruby-identifier">write</span> <span class="ruby-identifier">destroy</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-get_configuration" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get_configuration</span><span
|
||||
class="method-args">() { |stana| ... }</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="get_configuration-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 127</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_configuration</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">get_configure</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Owner</span><span class="ruby-operator">::</span><span class="ruby-constant">Configure</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:get</span>, <span class="ruby-ivar">@room</span>)
|
||||
<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">get_configure</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">stana</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">stana</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Also aliased as: <a href="MultiUserChat.html#method-i-configuration">configuration</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-invite" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">invite</span><span
|
||||
class="method-args">(jid, reason = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p><message to='room@service'></p>
|
||||
|
||||
<pre><x xmlns='http://jabber.org/protocol/muc#user'>
|
||||
<invite to='jid'>
|
||||
<reason>comment</reason>
|
||||
</invite>
|
||||
</x></pre>
|
||||
|
||||
<p></message></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="invite-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 81</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite</span>(<span class="ruby-identifier">jid</span>, <span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">message</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">message</span> <span class="ruby-operator"><<</span> <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Invite</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">jid</span>, <span class="ruby-identifier">reason</span>, <span class="ruby-ivar">@password</span>)
|
||||
|
||||
<span class="ruby-identifier">write</span> <span class="ruby-identifier">message</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-join" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">join</span><span
|
||||
class="method-args">(reason = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="join-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 55</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">join</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">join</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Presence</span><span class="ruby-operator">::</span><span class="ruby-constant">MUCJoin</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-identifier">join</span>.<span class="ruby-identifier">to</span> = <span class="ruby-node">"#{@room}/#{@nickname}"</span>
|
||||
<span class="ruby-identifier">join</span>.<span class="ruby-identifier">password</span> = <span class="ruby-ivar">@password</span>
|
||||
<span class="ruby-identifier">write</span> <span class="ruby-identifier">join</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-leave" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">leave</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="leave-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 106</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">leave</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">status</span> = <span class="ruby-value">:unavailable</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-members" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">members</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p><iq from='crone1@shakespeare.lit/desktop'</p>
|
||||
|
||||
<pre> id='member3'
|
||||
to='darkcave@chat.shakespeare.lit'
|
||||
type='get'>
|
||||
<query xmlns='http://jabber.org/protocol/muc#admin'>
|
||||
<item affiliation='member'/>
|
||||
</query></pre>
|
||||
|
||||
<p></iq></p>
|
||||
|
||||
<p><iq from='darkcave@chat.shakespeare.lit'</p>
|
||||
|
||||
<pre> id='member3'
|
||||
to='crone1@shakespeare.lit/desktop'
|
||||
type='result'>
|
||||
<query xmlns='http://jabber.org/protocol/muc#admin'>
|
||||
<item affiliation='member'
|
||||
jid='hag66@shakespeare.lit'
|
||||
nick='thirdwitch'
|
||||
role='participant'/>
|
||||
</query></pre>
|
||||
|
||||
<p></iq></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="members-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 173</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">members</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">members</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Admin</span><span class="ruby-operator">::</span><span class="ruby-constant">Members</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>)
|
||||
|
||||
<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">members</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-say" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">say</span><span
|
||||
class="method-args">(msg, xhtml = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p><message to='room@service' type='groupchat'></p>
|
||||
|
||||
<pre><body>foo</body></pre>
|
||||
|
||||
<p></message> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="say-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 91</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">say</span>(<span class="ruby-identifier">msg</span>, <span class="ruby-identifier">xhtml</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">message</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-value">:groupchat</span>)
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">xhtml</span> = <span class="ruby-identifier">xhtml</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">xhtml</span>
|
||||
<span class="ruby-identifier">write</span> <span class="ruby-identifier">message</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-set_configuration" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">set_configuration</span><span
|
||||
class="method-args">(values, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="set_configuration-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 135</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_configuration</span>(<span class="ruby-identifier">values</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">set_configure</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">MUC</span><span class="ruby-operator">::</span><span class="ruby-constant">Owner</span><span class="ruby-operator">::</span><span class="ruby-constant">Configure</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value">:set</span>, <span class="ruby-ivar">@room</span>)
|
||||
<span class="ruby-identifier">set_configure</span>.<span class="ruby-identifier">data</span> = <span class="ruby-identifier">values</span>
|
||||
<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">set_configure</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Also aliased as: <a href="MultiUserChat.html#method-i-configuration-3D">configuration=</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-set_default_configuration" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">set_default_configuration</span><span
|
||||
class="method-args">() { || ... }</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<pre><iq type='set' id='purple52b37aa2' to='test3@conference.macbook.local'>
|
||||
<query xmlns='http://jabber.org/protocol/muc#owner'>
|
||||
<x xmlns='jabber:x:data' type='submit'/></query></pre>
|
||||
|
||||
<p></iq></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="set_default_configuration-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 146</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_default_configuration</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">set_configuration</span>(<span class="ruby-value">:default</span>) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">yield</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Also aliased as: <a href="MultiUserChat.html#method-i-unlock">unlock</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-status-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">status=</span><span
|
||||
class="method-args">(state)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p><presence</p>
|
||||
|
||||
<pre> from='wiccarocks@shakespeare.lit/laptop'
|
||||
to='darkcave@chat.shakespeare.lit/oldhag'>
|
||||
<show>available</show></pre>
|
||||
|
||||
<p></presence></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="status-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 67</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">status=</span>(<span class="ruby-identifier">state</span>)
|
||||
<span class="ruby-identifier">status</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Presence</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-identifier">status</span>.<span class="ruby-identifier">state</span> = <span class="ruby-identifier">state</span>
|
||||
<span class="ruby-identifier">status</span>.<span class="ruby-identifier">to</span> = <span class="ruby-ivar">@room</span>
|
||||
<span class="ruby-identifier">write</span> <span class="ruby-identifier">status</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-subject-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">subject=</span><span
|
||||
class="method-args">(body)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p><message to='room@service' type='groupchat'></p>
|
||||
|
||||
<pre><subject>foo</subject></pre>
|
||||
|
||||
<p></message> </p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="subject-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 100</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subject=</span>(<span class="ruby-identifier">body</span>)
|
||||
<span class="ruby-identifier">message</span> = <span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@room</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">:groupchat</span>)
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">body</span>
|
||||
<span class="ruby-identifier">write</span> <span class="ruby-identifier">message</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-unlock" class="method-detail method-alias">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">unlock</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Alias for: <a href="MultiUserChat.html#method-i-set_default_configuration">set_default_configuration</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-write" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">write</span><span
|
||||
class="method-args">(stanza)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="write-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 179</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-identifier">stanza</span>)
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">stanza</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-write_with_handler" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">write_with_handler</span><span
|
||||
class="method-args">(stanza, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="write_with_handler-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 183</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_with_handler</span>(<span class="ruby-identifier">stanza</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">write_with_handler</span>(<span class="ruby-identifier">stanza</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</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>
|
||||
|
||||
99
doc/Blather/MUC.html
Normal file
99
doc/Blather/MUC.html
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module Blather::MUC - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-Blather::MUC">
|
||||
<h1 id="module-Blather::MUC" class="module">
|
||||
module Blather::MUC
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>Support for <a href="MUC.html"><code>MUC</code></a> Presense</p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
162
doc/Blather/MUC/Admin.html
Normal file
162
doc/Blather/MUC/Admin.html
Normal file
|
|
@ -0,0 +1,162 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::MUC::Admin - 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">Blather::Stanza::Iq::Query
|
||||
|
||||
</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::MUC::Admin">
|
||||
<h1 id="class-Blather::MUC::Admin" class="class">
|
||||
class Blather::MUC::Admin
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(type = nil, to = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 396</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">type</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">to</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">node</span> = <span class="ruby-keyword">super</span>(<span class="ruby-identifier">type</span>)
|
||||
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">to</span> = <span class="ruby-identifier">to</span>
|
||||
<span class="ruby-identifier">node</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>
|
||||
|
||||
220
doc/Blather/MUC/Admin/Members.html
Normal file
220
doc/Blather/MUC/Admin/Members.html
Normal file
|
|
@ -0,0 +1,220 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::MUC::Admin::Members - 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="../Admin.html">Blather::MUC::Admin</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-i-create_item">#create_item</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::MUC::Admin::Members">
|
||||
<h1 id="class-Blather::MUC::Admin::Members" class="class">
|
||||
class Blather::MUC::Admin::Members
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p><iq from='crone1@shakespeare.lit/desktop'</p>
|
||||
|
||||
<pre> id='member3'
|
||||
to='darkcave@chat.shakespeare.lit'
|
||||
type='get'>
|
||||
<query xmlns='http://jabber.org/protocol/muc#admin'>
|
||||
<item affiliation='member'/>
|
||||
</query></pre>
|
||||
|
||||
<p></iq></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">(*args)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
<a href="../Admin.html#method-c-new"><code>Blather::MUC::Admin::new</code></a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 411</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">query</span> = <span class="ruby-keyword">super</span>(<span class="ruby-value">:get</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">query</span>.<span class="ruby-identifier">create_item</span>
|
||||
<span class="ruby-identifier">query</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-create_item" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_item</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="create_item-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 417</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_item</span> <span class="ruby-comment"># @private</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_item</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:item'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-identifier">query</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_item</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'item'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-identifier">create_item</span>[<span class="ruby-value">:affiliation</span>] = <span class="ruby-string">'member'</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_item</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>
|
||||
|
||||
623
doc/Blather/MUC/Invite.html
Normal file
623
doc/Blather/MUC/Invite.html
Normal file
|
|
@ -0,0 +1,623 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::MUC::Invite - 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="../Stanza.html">Blather::Stanza</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-import">::import</a>
|
||||
|
||||
<li class="calls-super" ><a href="#method-c-new">::new</a>
|
||||
|
||||
<li ><a href="#method-i-create_invite">#create_invite</a>
|
||||
|
||||
<li ><a href="#method-i-create_password">#create_password</a>
|
||||
|
||||
<li ><a href="#method-i-create_reason">#create_reason</a>
|
||||
|
||||
<li ><a href="#method-i-inherit">#inherit</a>
|
||||
|
||||
<li ><a href="#method-i-invite_from">#invite_from</a>
|
||||
|
||||
<li ><a href="#method-i-invite_to">#invite_to</a>
|
||||
|
||||
<li ><a href="#method-i-invite_to-3D">#invite_to=</a>
|
||||
|
||||
<li ><a href="#method-i-password">#password</a>
|
||||
|
||||
<li ><a href="#method-i-password-3D">#password=</a>
|
||||
|
||||
<li ><a href="#method-i-reason">#reason</a>
|
||||
|
||||
<li ><a href="#method-i-reason-3D">#reason=</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::MUC::Invite">
|
||||
<h1 id="class-Blather::MUC::Invite" class="class">
|
||||
class Blather::MUC::Invite
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p><x xmlns='<a href="http://jabber.org/protocol/muc#user">jabber.org/protocol/muc#user</a>'></p>
|
||||
|
||||
<pre><invite to='jid'>
|
||||
<reason>comment</reason>
|
||||
</invite></pre>
|
||||
|
||||
<p></x></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-import" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">import</span><span
|
||||
class="method-args">(node)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="import-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 222</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">import</span>(<span class="ruby-identifier">node</span>)
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">element_name</span>).<span class="ruby-identifier">inherit</span>(<span class="ruby-identifier">node</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">(jid = nil, reason = nil, password = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 234</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">jid</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">invite</span> = <span class="ruby-keyword">super</span> <span class="ruby-value">:x</span>
|
||||
<span class="ruby-identifier">invite</span>.<span class="ruby-identifier">invite_to</span> = <span class="ruby-identifier">jid</span>
|
||||
<span class="ruby-identifier">invite</span>.<span class="ruby-identifier">reason</span> = <span class="ruby-identifier">reason</span>
|
||||
<span class="ruby-identifier">invite</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">invite</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-inherit" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">inherit</span><span
|
||||
class="method-args">(node)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="inherit-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 226</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inherit</span>(<span class="ruby-identifier">node</span>)
|
||||
<span class="ruby-identifier">create_invite</span>.<span class="ruby-identifier">remove</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">from</span> = <span class="ruby-identifier">node</span>[<span class="ruby-value">:from</span>]
|
||||
<span class="ruby-identifier">invite</span> = <span class="ruby-identifier">node</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:x/ns:invite'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-keyword">self</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">invite</span>
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-invite_from" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">invite_from</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="invite_from-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 250</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite_from</span>
|
||||
<span class="ruby-identifier">create_invite</span>[<span class="ruby-value">:from</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-invite_to" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">invite_to</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="invite_to-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 246</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite_to</span>
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">create_invite</span>[<span class="ruby-value">:to</span>])
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-invite_to-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">invite_to=</span><span
|
||||
class="method-args">(jid)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="invite_to-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 242</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invite_to=</span>(<span class="ruby-identifier">jid</span>)
|
||||
<span class="ruby-identifier">create_invite</span>[<span class="ruby-value">:to</span>] = <span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">jid</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-password" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">password</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="password-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 268</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password</span>
|
||||
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-password-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">password=</span><span
|
||||
class="method-args">(password)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="password-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 263</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password=</span>(<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">password</span>.<span class="ruby-identifier">blank?</span>
|
||||
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-reason" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">reason</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="reason-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 259</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason</span>
|
||||
<span class="ruby-identifier">create_reason</span>.<span class="ruby-identifier">content</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-reason-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">reason=</span><span
|
||||
class="method-args">(reason)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="reason-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 254</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason=</span>(<span class="ruby-identifier">reason</span>)
|
||||
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">reason</span>.<span class="ruby-identifier">blank?</span>
|
||||
<span class="ruby-identifier">create_reason</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">reason</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Protected Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-create_invite" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_invite</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="create_invite-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 280</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_invite</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_invite</span> = <span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:invite'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-keyword">self</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_invite</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'invite'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_invite</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-create_password" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_password</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="create_password-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 273</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_password</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_password</span> = <span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:password'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-keyword">self</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_password</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'password'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_password</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-create_reason" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_reason</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="create_reason-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 287</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_reason</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_reason</span> = <span class="ruby-identifier">create_invite</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:reason'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">create_invite</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_reason</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'reason'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_reason</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>
|
||||
|
||||
252
doc/Blather/MUC/Join.html
Normal file
252
doc/Blather/MUC/Join.html
Normal file
|
|
@ -0,0 +1,252 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::MUC::Join - 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">Blather::XMPPNode
|
||||
|
||||
</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-i-create_password">#create_password</a>
|
||||
|
||||
<li ><a href="#method-i-password-3D">#password=</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::MUC::Join">
|
||||
<h1 id="class-Blather::MUC::Join" class="class">
|
||||
class Blather::MUC::Join
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(password = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 195</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">password</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">join</span> = <span class="ruby-keyword">super</span> <span class="ruby-value">:x</span>
|
||||
<span class="ruby-identifier">join</span>.<span class="ruby-identifier">password</span> = <span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">join</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-password-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">password=</span><span
|
||||
class="method-args">(password)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="password-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 201</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password=</span>(<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">password</span>.<span class="ruby-identifier">blank?</span>
|
||||
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Protected Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-create_password" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_password</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="create_password-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 207</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_password</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_password</span> = <span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:password'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-keyword">self</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_password</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'password'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_password</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>
|
||||
|
||||
162
doc/Blather/MUC/Owner.html
Normal file
162
doc/Blather/MUC/Owner.html
Normal file
|
|
@ -0,0 +1,162 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::MUC::Owner - 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">Blather::Stanza::Iq::Query
|
||||
|
||||
</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::MUC::Owner">
|
||||
<h1 id="class-Blather::MUC::Owner" class="class">
|
||||
class Blather::MUC::Owner
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(type = nil, to = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 304</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">type</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">to</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">node</span> = <span class="ruby-keyword">super</span>(<span class="ruby-identifier">type</span>)
|
||||
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">to</span> = <span class="ruby-identifier">to</span>
|
||||
<span class="ruby-identifier">node</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>
|
||||
|
||||
274
doc/Blather/MUC/Owner/Configure.html
Normal file
274
doc/Blather/MUC/Owner/Configure.html
Normal file
|
|
@ -0,0 +1,274 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::MUC::Owner::Configure - 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="../Owner.html">Blather::MUC::Owner</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-i-create_data">#create_data</a>
|
||||
|
||||
<li ><a href="#method-i-data">#data</a>
|
||||
|
||||
<li ><a href="#method-i-data-3D">#data=</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::MUC::Owner::Configure">
|
||||
<h1 id="class-Blather::MUC::Owner::Configure" class="class">
|
||||
class Blather::MUC::Owner::Configure
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="DATA_NAMESPACE">DATA_NAMESPACE
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-data" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">data</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="data-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 333</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">data</span>
|
||||
<span class="ruby-identifier">items</span> = <span class="ruby-identifier">create_data</span>.<span class="ruby-identifier">find</span>(<span class="ruby-string">'//ns:field'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-identifier">items</span>.<span class="ruby-identifier">inject</span>({}) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">hash</span>, <span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">item</span>[<span class="ruby-value">:var</span>]
|
||||
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">item</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:value'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">content</span>
|
||||
<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span>
|
||||
<span class="ruby-identifier">hash</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-data-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">data=</span><span
|
||||
class="method-args">(data = :default)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="data-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 313</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">data=</span>(<span class="ruby-identifier">data</span> = <span class="ruby-value">:default</span>)
|
||||
<span class="ruby-identifier">create_data</span>[<span class="ruby-value">:type</span>] = <span class="ruby-string">'submit'</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">blank?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">data</span> <span class="ruby-operator">==</span> <span class="ruby-value">:default</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Invalid data format"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">create_field</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'field'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>)
|
||||
<span class="ruby-identifier">create_field</span>[<span class="ruby-value">:var</span>] = <span class="ruby-identifier">key</span>
|
||||
|
||||
<span class="ruby-identifier">create_field_value</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'value'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>)
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-constant">TrueClass</span>, <span class="ruby-constant">FalseClass</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">value</span>.<span class="ruby-identifier">class</span>)
|
||||
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">value</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_field_value</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">to_s</span>
|
||||
|
||||
<span class="ruby-identifier">create_field</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">create_field_value</span>
|
||||
<span class="ruby-identifier">create_data</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">create_field</span>
|
||||
}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Protected Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-create_data" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_data</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="create_data-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 345</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_data</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_data</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:x'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-constant">DATA_NAMESPACE</span>)
|
||||
<span class="ruby-identifier">query</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_data</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'x'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-identifier">create_data</span>.<span class="ruby-identifier">namespace</span> = <span class="ruby-constant">DATA_NAMESPACE</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_data</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>
|
||||
|
||||
295
doc/Blather/MUC/Owner/Destroy.html
Normal file
295
doc/Blather/MUC/Owner/Destroy.html
Normal file
|
|
@ -0,0 +1,295 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::MUC::Owner::Destroy - 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="../Owner.html">Blather::MUC::Owner</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-i-create_destroy">#create_destroy</a>
|
||||
|
||||
<li ><a href="#method-i-create_reason">#create_reason</a>
|
||||
|
||||
<li ><a href="#method-i-reason-3D">#reason=</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::MUC::Owner::Destroy">
|
||||
<h1 id="class-Blather::MUC::Owner::Destroy" class="class">
|
||||
class Blather::MUC::Owner::Destroy
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p><iq from='crone1@shakespeare.lit/desktop'</p>
|
||||
|
||||
<pre> id='begone'
|
||||
to='heath@chat.shakespeare.lit'
|
||||
type='set'>
|
||||
<query xmlns='http://jabber.org/protocol/muc#owner'>
|
||||
<destroy jid='darkcave@chat.shakespeare.lit'>
|
||||
<reason>Macbeth doth come.</reason>
|
||||
</destroy>
|
||||
</query></pre>
|
||||
|
||||
<p></iq></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">(*args)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
<a href="../Owner.html#method-c-new"><code>Blather::MUC::Owner::new</code></a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 366</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">query</span> = <span class="ruby-keyword">super</span>(<span class="ruby-value">:set</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">query</span>.<span class="ruby-identifier">create_destroy</span>
|
||||
<span class="ruby-identifier">query</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-create_destroy" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_destroy</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="create_destroy-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 384</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_destroy</span> <span class="ruby-comment"># @private</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_destroy</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:destroy'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-identifier">query</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_destroy</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'destroy'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_destroy</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-create_reason" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">create_reason</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="create_reason-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 377</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_reason</span> <span class="ruby-comment"># @private</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">create_reason</span> = <span class="ruby-identifier">create_destroy</span>.<span class="ruby-identifier">find_first</span>(<span class="ruby-string">'ns:reason'</span>, <span class="ruby-value">:ns</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">registered_ns</span>)
|
||||
<span class="ruby-identifier">create_destroy</span> <span class="ruby-operator"><<</span> (<span class="ruby-identifier">create_reason</span> = <span class="ruby-constant">XMPPNode</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'reason'</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">document</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">create_reason</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-reason-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">reason=</span><span
|
||||
class="method-args">(reason)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="reason-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 372</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reason=</span>(<span class="ruby-identifier">reason</span>)
|
||||
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">reason</span>.<span class="ruby-identifier">blank?</span>
|
||||
<span class="ruby-identifier">create_reason</span>.<span class="ruby-identifier">content</span> = <span class="ruby-identifier">reason</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>
|
||||
|
||||
193
doc/Blather/Roster.html
Normal file
193
doc/Blather/Roster.html
Normal file
|
|
@ -0,0 +1,193 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::Roster - 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-i-add">#add</a>
|
||||
|
||||
<li ><a href="#method-i-push">#push</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::Roster">
|
||||
<h1 id="class-Blather::Roster" class="class">
|
||||
class Blather::Roster
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-add" class="method-detail method-alias">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">add</span><span
|
||||
class="method-args">(elem, send = true, groups = ["Buddies"])</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Alias for: <a href="Roster.html#method-i-push">push</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-push" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">push</span><span
|
||||
class="method-args">(elem, send = true, groups = ["Buddies"])</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="push-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 27</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">push</span>(<span class="ruby-identifier">elem</span>, <span class="ruby-identifier">send</span> = <span class="ruby-keyword">true</span>, <span class="ruby-identifier">groups</span> = [<span class="ruby-string">"Buddies"</span>])
|
||||
<span class="ruby-identifier">jid</span> = <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:jid</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">jid</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">elem</span>.<span class="ruby-identifier">jid</span> <span class="ruby-operator">:</span> <span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">elem</span>)
|
||||
<span class="ruby-ivar">@items</span>[<span class="ruby-identifier">key</span>(<span class="ruby-identifier">jid</span>)] = <span class="ruby-identifier">node</span> = <span class="ruby-constant">RosterItem</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">elem</span>)
|
||||
<span class="ruby-ivar">@items</span>[<span class="ruby-identifier">key</span>(<span class="ruby-identifier">jid</span>)].<span class="ruby-identifier">subscription</span> = <span class="ruby-value">:both</span>
|
||||
<span class="ruby-ivar">@items</span>[<span class="ruby-identifier">key</span>(<span class="ruby-identifier">jid</span>)].<span class="ruby-identifier">groups</span> = <span class="ruby-identifier">groups</span>
|
||||
<span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">to_stanza</span>(<span class="ruby-value">:set</span>)) <span class="ruby-keyword">if</span> <span class="ruby-identifier">send</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Also aliased as: <a href="Roster.html#method-i-add">add</a>
|
||||
</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>
|
||||
|
||||
104
doc/Blather/Stanza.html
Normal file
104
doc/Blather/Stanza.html
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::Stanza - 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>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::Stanza">
|
||||
<h1 id="class-Blather::Stanza" class="class">
|
||||
class Blather::Stanza
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
104
doc/Blather/Stanza/Presence.html
Normal file
104
doc/Blather/Stanza/Presence.html
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::Stanza::Presence - 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>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::Stanza::Presence">
|
||||
<h1 id="class-Blather::Stanza::Presence" class="class">
|
||||
class Blather::Stanza::Presence
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
205
doc/Blather/Stanza/Presence/MUCJoin.html
Normal file
205
doc/Blather/Stanza/Presence/MUCJoin.html
Normal file
|
|
@ -0,0 +1,205 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::Stanza::Presence::MUCJoin - 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="../Presence.html">Blather::Stanza::Presence</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-i-password">#password</a>
|
||||
|
||||
<li ><a href="#method-i-password-3D">#password=</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::Stanza::Presence::MUCJoin">
|
||||
<h1 id="class-Blather::Stanza::Presence::MUCJoin" class="class">
|
||||
class Blather::Stanza::Presence::MUCJoin
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="MUC_NS">MUC_NS
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-password" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">password</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="password-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 436</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password</span>
|
||||
<span class="ruby-identifier">create_muc</span>.<span class="ruby-identifier">content_from</span> <span class="ruby-value">:password</span>
|
||||
<span class="ruby-identifier">create_password</span>.<span class="ruby-identifier">content</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-password-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">password=</span><span
|
||||
class="method-args">(value)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="password-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 441</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">password=</span>(<span class="ruby-identifier">value</span>)
|
||||
<span class="ruby-identifier">create_muc</span>.<span class="ruby-identifier">set_content_for</span> <span class="ruby-value">:password</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>
|
||||
|
||||
344
doc/Blather/Stanza/Presence/MUCUser.html
Normal file
344
doc/Blather/Stanza/Presence/MUCUser.html
Normal file
|
|
@ -0,0 +1,344 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::Stanza::Presence::MUCUser - 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="../Presence.html">Blather::Stanza::Presence</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-i-affiliation">#affiliation</a>
|
||||
|
||||
<li ><a href="#method-i-affiliation-3D">#affiliation=</a>
|
||||
|
||||
<li ><a href="#method-i-jid">#jid</a>
|
||||
|
||||
<li ><a href="#method-i-jid-3D">#jid=</a>
|
||||
|
||||
<li ><a href="#method-i-role">#role</a>
|
||||
|
||||
<li ><a href="#method-i-role-3D">#role=</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::Stanza::Presence::MUCUser">
|
||||
<h1 id="class-Blather::Stanza::Presence::MUCUser" class="class">
|
||||
class Blather::Stanza::Presence::MUCUser
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="MUC_NS">MUC_NS
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-affiliation" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">affiliation</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="affiliation-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 476</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">affiliation</span>
|
||||
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:affiliation</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-affiliation-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">affiliation=</span><span
|
||||
class="method-args">(val)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="affiliation-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 480</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">affiliation=</span>(<span class="ruby-identifier">val</span>)
|
||||
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:affiliation</span>] = <span class="ruby-identifier">val</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-jid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">jid</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="jid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 492</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">jid</span>
|
||||
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:jid</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-jid-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">jid=</span><span
|
||||
class="method-args">(val)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="jid-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 496</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">jid=</span>(<span class="ruby-identifier">val</span>)
|
||||
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:jid</span>] = <span class="ruby-identifier">val</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-role" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">role</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="role-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 484</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">role</span>
|
||||
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:role</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-role-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">role=</span><span
|
||||
class="method-args">(val)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="role-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 488</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">role=</span>(<span class="ruby-identifier">val</span>)
|
||||
<span class="ruby-identifier">create_ia</span>[<span class="ruby-value">:role</span>] = <span class="ruby-identifier">val</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>
|
||||
|
||||
240
doc/Blather/Stanza/Presence/MUCUser/Status.html
Normal file
240
doc/Blather/Stanza/Presence/MUCUser/Status.html
Normal file
|
|
@ -0,0 +1,240 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Blather::Stanza::Presence::MUCUser::Status - 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">Blather::XMPPNode
|
||||
|
||||
</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-i-code">#code</a>
|
||||
|
||||
<li ><a href="#method-i-code-3D">#code=</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Blather::Stanza::Presence::MUCUser::Status">
|
||||
<h1 id="class-Blather::Stanza::Presence::MUCUser::Status" class="class">
|
||||
class Blather::Stanza::Presence::MUCUser::Status
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(code)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 457</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">new</span>(<span class="ruby-identifier">code</span>)
|
||||
<span class="ruby-identifier">new_node</span> = <span class="ruby-keyword">super</span> <span class="ruby-value">:status</span>
|
||||
<span class="ruby-identifier">new_node</span>.<span class="ruby-identifier">code</span> = <span class="ruby-identifier">code</span>
|
||||
<span class="ruby-identifier">new_node</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-code" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">code</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="code-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 463</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">code</span>
|
||||
<span class="ruby-identifier">read_attr</span> <span class="ruby-value">:code</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-code-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">code=</span><span
|
||||
class="method-args">(var)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="code-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 467</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">code=</span>(<span class="ruby-identifier">var</span>)
|
||||
<span class="ruby-identifier">write_attr</span> <span class="ruby-value">:code</span>, <span class="ruby-identifier">var</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>
|
||||
|
||||
166
doc/Class.html
Normal file
166
doc/Class.html
Normal file
|
|
@ -0,0 +1,166 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Class - 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-i-descendants">#descendants</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Class">
|
||||
<h1 id="class-Class" class="class">
|
||||
class Class
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
<hr>
|
||||
|
||||
<p>Additional alternations to Standard element classes: expanded functionality (Tier 1 Augmentation)</p>
|
||||
|
||||
<p><a href="Class.html"><code>Class</code></a> extensions:</p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-descendants" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">descendants</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Attribution : <a href="http://stackoverflow.com/questions/2393697/look-up-all-descendants-of-a-class-in-ruby">stackoverflow.com/questions/2393697/look-up-all-descendants-of-a-class-in-ruby</a></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="descendants-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 23</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">descendants</span>
|
||||
<span class="ruby-identifier">result</span> = []
|
||||
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">each_object</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Class</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_class</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_class</span> <span class="ruby-operator"><</span> <span class="ruby-keyword">self</span>
|
||||
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_class</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>
|
||||
|
||||
99
doc/EZMQ.html
Normal file
99
doc/EZMQ.html
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module EZMQ - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-EZMQ">
|
||||
<h1 id="module-EZMQ" class="module">
|
||||
module EZMQ
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>Patches to EZMQ:</p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
156
doc/EZMQ/Publisher.html
Normal file
156
doc/EZMQ/Publisher.html
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class EZMQ::Publisher - 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-i-send">#send</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-EZMQ::Publisher">
|
||||
<h1 id="class-EZMQ::Publisher" class="class">
|
||||
class EZMQ::Publisher
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-send" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">send</span><span
|
||||
class="method-args">(message="", topic='', **options)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="send-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 7</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send</span>(<span class="ruby-identifier">message</span>=<span class="ruby-string">""</span>, <span class="ruby-identifier">topic</span>=<span class="ruby-string">''</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-identifier">message</span> = <span class="ruby-node">"#{ topic } #{ (options[:encode] || @encode).call message }"</span>
|
||||
<span class="ruby-ivar">@socket</span>.<span class="ruby-identifier">send_string</span> <span class="ruby-identifier">message</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>
|
||||
|
||||
116
doc/Fcntl.html
Normal file
116
doc/Fcntl.html
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module Fcntl - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-Fcntl">
|
||||
<h1 id="module-Fcntl" class="module">
|
||||
module Fcntl
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="O_BINARY">O_BINARY
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="O_TEXT">O_TEXT
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</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>
|
||||
|
||||
813
doc/File.html
Normal file
813
doc/File.html
Normal file
|
|
@ -0,0 +1,813 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class File - 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-find_file_mimetype">::find_file_mimetype</a>
|
||||
|
||||
<li ><a href="#method-c-gxg_permissions_to_mode">::gxg_permissions_to_mode</a>
|
||||
|
||||
<li ><a href="#method-c-gxg_permissions_to_unix">::gxg_permissions_to_unix</a>
|
||||
|
||||
<li ><a href="#method-c-mode_permission_to_gxg">::mode_permission_to_gxg</a>
|
||||
|
||||
<li ><a href="#method-c-mode_permission_to_unix">::mode_permission_to_unix</a>
|
||||
|
||||
<li ><a href="#method-c-unix_permissions_to_gxg">::unix_permissions_to_gxg</a>
|
||||
|
||||
<li ><a href="#method-i-file_type">#file_type</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-File">
|
||||
<h1 id="class-File" class="class">
|
||||
class File
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="DUPLEX">DUPLEX
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="SETENC_BY_BOM">SETENC_BY_BOM
|
||||
|
||||
<dd><p>Note: need to verify ::IO::SETENC_BY_BOM value before using:</p>
|
||||
|
||||
|
||||
<dt id="TEXT">TEXT
|
||||
|
||||
<dd><p>What is the flag value under Win32?</p>
|
||||
|
||||
|
||||
<dt id="TTY">TTY
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="WSPLIT">WSPLIT
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="WSPLIT_INITIALIZED">WSPLIT_INITIALIZED
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Class Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-c-find_file_mimetype" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">find_file_mimetype</span><span
|
||||
class="method-args">(the_file=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="find_file_mimetype-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 847</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">find_file_mimetype</span>(<span class="ruby-identifier">the_file</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_file</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-regexp">/.*(?:\\|\/)(.+)$/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">the_file</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">the_file</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">the_file</span> <span class="ruby-operator">==</span> <span class="ruby-string">"/"</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">the_file</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"You tried to look at a directory, not a File. (#{the_file.inspect})."</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">the_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">the_file</span>, <span class="ruby-string">"r"</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid File path."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_file</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>)
|
||||
<span class="ruby-identifier">the_file</span>.<span class="ruby-identifier">file_type</span>()
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid File object."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-gxg_permissions_to_mode" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">gxg_permissions_to_mode</span><span
|
||||
class="method-args">(permissions={:owner => { :execute => false, :rename => false, :move => false, :destroy => false, :create => false, :write => false, :read => false }, :group => { :execute => false, :rename => false, :move => false, :destroy => false, :create => false, :write => false, :read => false }, :other => { :execute => false, :rename => false, :move => false, :destroy => false, :create => false, :write => false, :read => false }}, type = :file)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="gxg_permissions_to_mode-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 1120</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">gxg_permissions_to_mode</span>(<span class="ruby-identifier">permissions</span>={<span class="ruby-value">:owner</span> <span class="ruby-operator">=></span> { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }, <span class="ruby-value">:group</span> <span class="ruby-operator">=></span> { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }, <span class="ruby-value">:other</span> <span class="ruby-operator">=></span> { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }}, <span class="ruby-identifier">type</span> = <span class="ruby-value">:file</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">octet</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">octet_string</span> = <span class="ruby-string">"0"</span>
|
||||
<span class="ruby-identifier">unix_permissions</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">gxg_permissions_to_unix</span>(<span class="ruby-identifier">permissions</span>,<span class="ruby-identifier">type</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">unix_permissions</span>.<span class="ruby-identifier">each_char_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">character</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">3</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">index</span>)
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">index</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">3</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">index</span> <span class="ruby-operator">==</span> <span class="ruby-value">3</span>
|
||||
<span class="ruby-identifier">octet_string</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">octet</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">octet</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-value">4</span><span class="ruby-operator">..</span><span class="ruby-value">6</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">index</span>)
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">index</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">5</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">6</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">index</span> <span class="ruby-operator">==</span> <span class="ruby-value">6</span>
|
||||
<span class="ruby-identifier">octet_string</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">octet</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">octet</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-value">7</span><span class="ruby-operator">..</span><span class="ruby-value">9</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">index</span>)
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">index</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">7</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">8</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-identifier">octet</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">index</span> <span class="ruby-operator">==</span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-identifier">octet_string</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">octet</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">octet</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">octet_string</span>.<span class="ruby-identifier">to_i</span>(<span class="ruby-identifier">base</span>=<span class="ruby-value">8</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a Hash with :owner, :group, and :other permission sub-hashes of true/false flags"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-gxg_permissions_to_unix" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">gxg_permissions_to_unix</span><span
|
||||
class="method-args">(permissions={:owner => { :execute => false, :rename => false, :move => false, :destroy => false, :create => false, :write => false, :read => false }, :group => { :execute => false, :rename => false, :move => false, :destroy => false, :create => false, :write => false, :read => false }, :other => { :execute => false, :rename => false, :move => false, :destroy => false, :create => false, :write => false, :read => false }}, type = :file)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="gxg_permissions_to_unix-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 1027</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">gxg_permissions_to_unix</span>(<span class="ruby-identifier">permissions</span>={<span class="ruby-value">:owner</span> <span class="ruby-operator">=></span> { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }, <span class="ruby-value">:group</span> <span class="ruby-operator">=></span> { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }, <span class="ruby-value">:other</span> <span class="ruby-operator">=></span> { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }}, <span class="ruby-identifier">type</span> = <span class="ruby-value">:file</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-string">"----------"</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">accumulator</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">raw_data</span> = <span class="ruby-string">"----------"</span>
|
||||
<span class="ruby-identifier">write_permissions</span> = [<span class="ruby-value">:write</span>, <span class="ruby-value">:create</span>, <span class="ruby-value">:destroy</span>, <span class="ruby-value">:rename</span>, <span class="ruby-value">:move</span>]
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:directory</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"d"</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:symlink</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"l"</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:file</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid file system entity type: :file, :directory or :symlink."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">each_char_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">character</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">index</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:read</span>]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">write_permissions</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_perm</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:owner</span>][(<span class="ruby-identifier">the_perm</span>)]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">accumulator</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">!=</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">3</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:execute</span>]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:read</span>]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">5</span>
|
||||
<span class="ruby-identifier">write_permissions</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_perm</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:group</span>][(<span class="ruby-identifier">the_perm</span>)]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">accumulator</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">!=</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">6</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:execute</span>]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">7</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:read</span>]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">8</span>
|
||||
<span class="ruby-identifier">write_permissions</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_perm</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:other</span>][(<span class="ruby-identifier">the_perm</span>)]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">accumulator</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">!=</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permissions</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:execute</span>]
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">character</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">accumulator</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a Hash with :owner, :group, and :other permission sub-hashes of true/false flags"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-mode_permission_to_gxg" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">mode_permission_to_gxg</span><span
|
||||
class="method-args">(the_mode=0)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="mode_permission_to_gxg-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 866</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">mode_permission_to_gxg</span>(<span class="ruby-identifier">the_mode</span>=<span class="ruby-value">0</span>)
|
||||
<span class="ruby-identifier">result</span> = {}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_mode</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">raw_mode</span> = <span class="ruby-identifier">the_mode</span>.<span class="ruby-identifier">to_s</span>(<span class="ruby-identifier">base</span>=<span class="ruby-value">8</span>)
|
||||
<span class="ruby-identifier">set_user_id</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-identifier">set_group_id</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-identifier">set_sticky_bit</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">raw_mode</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator"><</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">raw_mode</span> = (<span class="ruby-string">"0"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">raw_mode</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_mode</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">raw_mode</span> = <span class="ruby-identifier">raw_mode</span>[((<span class="ruby-identifier">raw_mode</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">4</span>)<span class="ruby-operator">..</span><span class="ruby-value">-1</span>)].<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">set_user_id</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">set_group_id</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">set_sticky_bit</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">raw_permission</span> = { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }
|
||||
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:effective</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:owner</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">raw_permission</span>.<span class="ruby-identifier">clone</span>, <span class="ruby-value">:group</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">raw_permission</span>.<span class="ruby-identifier">clone</span>, <span class="ruby-value">:other</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">raw_permission</span>.<span class="ruby-identifier">clone</span>}
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment"># puts "using: #{raw_mode.inspect}"</span>
|
||||
<span class="ruby-comment"># owner permissions</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:read</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:write</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:rename</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:move</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:destroy</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:create</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:execute</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># group permissions</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:read</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:write</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:rename</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:move</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:destroy</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:create</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:execute</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># other permissions</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:read</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:write</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:rename</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:move</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:destroy</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:create</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:execute</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide an Integer"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-mode_permission_to_unix" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">mode_permission_to_unix</span><span
|
||||
class="method-args">(the_mode=0, type = :file)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="mode_permission_to_unix-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 941</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">mode_permission_to_unix</span>(<span class="ruby-identifier">the_mode</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">type</span> = <span class="ruby-value">:file</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-string">"----------"</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_mode</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">accumulator</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">raw_mode</span> = <span class="ruby-identifier">the_mode</span>.<span class="ruby-identifier">to_s</span>(<span class="ruby-identifier">base</span>=<span class="ruby-value">8</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_mode</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator"><</span> <span class="ruby-value">7</span>
|
||||
<span class="ruby-identifier">raw_mode</span> = (<span class="ruby-string">"0"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">raw_mode</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">set_user_id</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-identifier">set_group_id</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-identifier">set_sticky_bit</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">set_user_id</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">set_group_id</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">set_sticky_bit</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:directory</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"d"</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:symlink</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"l"</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:file</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid file system entity type: :file, :directory or :symlink."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># owner permissions</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># group permissions</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># other permissions</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">4</span>) <span class="ruby-operator">==</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">2</span>) <span class="ruby-operator">==</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_mode</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"-"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">accumulator</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide an Integer"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-unix_permissions_to_gxg" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">unix_permissions_to_gxg</span><span
|
||||
class="method-args">(permission_string="")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="unix_permissions_to_gxg-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 1201</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">unix_permissions_to_gxg</span>(<span class="ruby-identifier">permission_string</span>=<span class="ruby-string">""</span>)
|
||||
<span class="ruby-identifier">raw_permission</span> = { <span class="ruby-value">:execute</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:rename</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:move</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:destroy</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span> }
|
||||
<span class="ruby-identifier">blank_permissions</span> = {<span class="ruby-value">:effective</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:owner</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">raw_permission</span>.<span class="ruby-identifier">clone</span>, <span class="ruby-value">:group</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">raw_permission</span>.<span class="ruby-identifier">clone</span>, <span class="ruby-value">:other</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">raw_permission</span>.<span class="ruby-identifier">clone</span>}
|
||||
<span class="ruby-identifier">permission_record</span> = <span class="ruby-identifier">blank_permissions</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">permission_string</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">permission_string</span>.<span class="ruby-identifier">each_char_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">character</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">index</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:read</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:write</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:rename</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:move</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:destroy</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:create</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">3</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:owner</span>][<span class="ruby-value">:execute</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">4</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:read</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">5</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:write</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:rename</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:move</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:destroy</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:create</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">6</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:group</span>][<span class="ruby-value">:execute</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">7</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"r"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:read</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">8</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"w"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:write</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:rename</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:move</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:destroy</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:create</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">character</span> <span class="ruby-operator">==</span> <span class="ruby-string">"x"</span>
|
||||
<span class="ruby-identifier">permission_record</span>[<span class="ruby-value">:other</span>][<span class="ruby-value">:execute</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># No way to calculate Effective Permissions - it will be nil consequently.</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">permission_record</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST supply a valid unix permission String"</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 id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-file_type" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">file_type</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="file_type-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 1270</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">file_type</span>()
|
||||
<span class="ruby-comment"># TODO: return GxG-UFS value as well.</span>
|
||||
<span class="ruby-identifier">type</span> = <span class="ruby-operator">::</span><span class="ruby-constant">MimeMagic</span>.<span class="ruby-identifier">by_path</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">path</span>)
|
||||
{<span class="ruby-value">:mime_type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">type</span>(), <span class="ruby-value">:subtype</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">subtype</span>(), <span class="ruby-value">:mediatype</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">mediatype</span>(), <span class="ruby-value">:extensions</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">extensions</span>(), <span class="ruby-value">:comment</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">type</span>.<span class="ruby-identifier">comment</span>(), <span class="ruby-value">:ufs</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</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>
|
||||
|
||||
284
doc/Float.html
Normal file
284
doc/Float.html
Normal file
|
|
@ -0,0 +1,284 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class Float - 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-i-clone">#clone</a>
|
||||
|
||||
<li ><a href="#method-i-dup">#dup</a>
|
||||
|
||||
<li ><a href="#method-i-initialize_clone">#initialize_clone</a>
|
||||
|
||||
<li ><a href="#method-i-initialize_dup">#initialize_dup</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-Float">
|
||||
<h1 id="class-Float" class="class">
|
||||
class Float
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>class FalseClass</p>
|
||||
|
||||
<pre class="ruby"><span class="ruby-identifier">public</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize_clone</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">alias</span> <span class="ruby-value">:initialize_dup</span> <span class="ruby-value">:initialize_clone</span>
|
||||
<span class="ruby-keyword">alias</span> <span class="ruby-value">:dup</span> <span class="ruby-value">:initialize_clone</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clone</span>()
|
||||
<span class="ruby-identifier">initialize_clone</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
</pre>
|
||||
|
||||
<p>end</p>
|
||||
|
||||
<p>class TrueClass</p>
|
||||
|
||||
<pre class="ruby"><span class="ruby-identifier">public</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize_clone</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">alias</span> <span class="ruby-value">:initialize_dup</span> <span class="ruby-value">:initialize_clone</span>
|
||||
<span class="ruby-keyword">alias</span> <span class="ruby-value">:dup</span> <span class="ruby-value">:initialize_clone</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clone</span>()
|
||||
<span class="ruby-identifier">initialize_clone</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
</pre>
|
||||
|
||||
<p>end</p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-clone" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">clone</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="clone-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 80</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clone</span>()
|
||||
<span class="ruby-identifier">initialize_clone</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-dup" class="method-detail method-alias">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">dup</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Alias for: <a href="Float.html#method-i-initialize_clone">initialize_clone</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-initialize_clone" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">initialize_clone</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="initialize_clone-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_augmented.rb, line 75</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize_clone</span>
|
||||
(<span class="ruby-keyword">self</span> <span class="ruby-operator">+</span> <span class="ruby-value">0.0</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Also aliased as: <a href="Float.html#method-i-initialize_dup">initialize_dup</a>, <a href="Float.html#method-i-dup">dup</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-initialize_dup" class="method-detail method-alias">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">initialize_dup</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Alias for: <a href="Float.html#method-i-initialize_clone">initialize_clone</a>
|
||||
</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>
|
||||
|
||||
629
doc/GxG.html
Normal file
629
doc/GxG.html
Normal file
|
|
@ -0,0 +1,629 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-c-apportioned_ranges">::apportioned_ranges</a>
|
||||
|
||||
<li ><a href="#method-c-passes_needed">::passes_needed</a>
|
||||
|
||||
<li ><a href="#method-c-reconstitute">::reconstitute</a>
|
||||
|
||||
<li ><a href="#method-c-shutdown">::shutdown</a>
|
||||
|
||||
<li ><a href="#method-c-sql_statement-3F">::sql_statement?</a>
|
||||
|
||||
<li ><a href="#method-c-uuid_generate">::uuid_generate</a>
|
||||
|
||||
<li ><a href="#method-c-valid_domain_name-3F">::valid_domain_name?</a>
|
||||
|
||||
<li ><a href="#method-c-valid_uuid-3F">::valid_uuid?</a>
|
||||
|
||||
<li ><a href="#method-i-find_local">#find_local</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG">
|
||||
<h1 id="module-GxG" class="module">
|
||||
module GxG
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<pre>---------------------------------------------------------------------------------------------------------------------</pre>
|
||||
|
||||
<p>Various preliminary patches to dependencies:</p>
|
||||
<hr>
|
||||
|
||||
<p>Various preliminary patches to standard classes: <none></p>
|
||||
<hr>
|
||||
|
||||
<p>main module declaration:</p>
|
||||
<hr>
|
||||
|
||||
<p>Set <a href="GxG.html"><code>GxG</code></a> <a href="GxG/Version.html"><code>Version</code></a> and instantiate <a href="GxG.html#SYSTEM"><code>GxG::SYSTEM</code></a> object:</p>
|
||||
|
||||
<p>First attempt at object serialization/reconstitution:</p>
|
||||
|
||||
<p>determine the arch, platform with version, and ruby implementation with version store this in <a href="GxG.html#BOOTSTRAP"><code>GxG::BOOTSTRAP</code></a></p>
|
||||
|
||||
<p>To overcome load-order issues:</p>
|
||||
|
||||
<p><a href="GxG.html"><code>GxG</code></a> <a href="GxG/Communications.html"><code>Communications</code></a> Layer</p>
|
||||
|
||||
<p>PeristedArray Code:</p>
|
||||
|
||||
<p>PersistedHash Code:</p>
|
||||
<hr>
|
||||
|
||||
<p>Various data element classes:</p>
|
||||
<hr>
|
||||
|
||||
<p><a href="GxG.html"><code>GxG</code></a> <a href="GxG/Engine.html"><code>Engine</code></a> interface: rational memory management, and quota supports</p>
|
||||
<hr>
|
||||
|
||||
<p>Preliminary <a href="GxG/Entity.html"><code>Entity</code></a> supports</p>
|
||||
|
||||
<p><a href="GxG/IO.html"><code>IO</code></a> <a href="GxG/Support.html"><code>Support</code></a> Library Module & <a href="GxG/IO.html"><code>IO</code></a> Classes ############################################</p>
|
||||
|
||||
<p>Auto-Transcoding <a href="GxG/Support.html"><code>Support</code></a> Library Module ############################################</p>
|
||||
<hr>
|
||||
|
||||
<p><a href="GxG/Units.html"><code>Units</code></a> and support element classes:</p>
|
||||
|
||||
<p>gxg_ipc is there to pick the bones, but will be discarded : use this file.</p>
|
||||
|
||||
<p>GxG:</p>
|
||||
|
||||
<p><a href="GxG/Networking.html"><code>Networking</code></a> Section of <a href="GxG.html"><code>GxG</code></a></p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="BOOTSTRAP">BOOTSTRAP
|
||||
|
||||
<dd><p>cleanup</p>
|
||||
|
||||
<p>return final result</p>
|
||||
|
||||
|
||||
<dt id="BRIDGES">BRIDGES
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="BRIDGES_AVAILABLE">BRIDGES_AVAILABLE
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="DB">DB
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="LOG">LOG
|
||||
|
||||
<dd><p><a href="GxG.html#LOG"><code>LOG</code></a> = $LOG</p>
|
||||
|
||||
|
||||
<dt id="RUBY_ENGINE">RUBY_ENGINE
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="SYSTEM">SYSTEM
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
<dt id="VERSION">VERSION
|
||||
|
||||
<dd><p>setup constants, dispose of <a href="GxG.html#BOOTSTRAP"><code>BOOTSTRAP</code></a> data.</p>
|
||||
|
||||
|
||||
<dt id="VFS">VFS
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Class Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-c-apportioned_ranges" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">apportioned_ranges</span><span
|
||||
class="method-args">(how_much_data=0, container_limit=0, original_offset=0)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="apportioned_ranges-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 530</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">apportioned_ranges</span>(<span class="ruby-identifier">how_much_data</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">container_limit</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">original_offset</span>=<span class="ruby-value">0</span>)
|
||||
<span class="ruby-identifier">result</span> = []
|
||||
<span class="ruby-identifier">the_count</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">passes_needed</span>(<span class="ruby-identifier">how_much_data</span>, <span class="ruby-identifier">container_limit</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_count</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">offset</span> = <span class="ruby-identifier">original_offset</span>
|
||||
<span class="ruby-identifier">the_count</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">offset</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">container_limit</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)) <span class="ruby-operator"><=</span> (<span class="ruby-identifier">how_much_data</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-identifier">end_point</span> = (<span class="ruby-identifier">offset</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">container_limit</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">end_point</span> = (<span class="ruby-identifier">how_much_data</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> ((<span class="ruby-identifier">offset</span>)<span class="ruby-operator">..</span>(<span class="ruby-identifier">end_point</span>))
|
||||
<span class="ruby-identifier">offset</span> = (<span class="ruby-identifier">end_point</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</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>
|
||||
|
||||
|
||||
<div id="method-c-passes_needed" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">passes_needed</span><span
|
||||
class="method-args">(size_used=0, container_limit=0)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Generic toolbox of methods</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="passes_needed-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 516</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">passes_needed</span>(<span class="ruby-identifier">size_used</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">container_limit</span>=<span class="ruby-value">0</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">size_used</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">container_limit</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">needed_raw</span> = <span class="ruby-identifier">size_used</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">container_limit</span>.<span class="ruby-identifier">to_f</span>
|
||||
<span class="ruby-identifier">overhang</span> = <span class="ruby-identifier">needed_raw</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">needed_raw</span>.<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">to_f</span>
|
||||
<span class="ruby-identifier">needed_raw</span> = <span class="ruby-identifier">needed_raw</span>.<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">to_f</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">overhang</span> <span class="ruby-operator">></span> <span class="ruby-value">0.0</span>
|
||||
<span class="ruby-identifier">needed_raw</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1.0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">needed_raw</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-reconstitute" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">reconstitute</span><span
|
||||
class="method-args">(raw_data="")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="reconstitute-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 472</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">reconstitute</span>(<span class="ruby-identifier">raw_data</span>=<span class="ruby-string">""</span>)
|
||||
<span class="ruby-comment"># See: http://stackoverflow.com/questions/5758464/ruby-how-do-i-check-if-a-class-is-defined</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">serialized?</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"marshal:"</span>)
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">raw_data</span>[(<span class="ruby-value">8</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)].<span class="ruby-identifier">decode64</span>())
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
|
||||
<span class="ruby-comment"># Question : what to do here.</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"structure:"</span>)
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">raw_data</span>[(<span class="ruby-value">10</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)].<span class="ruby-identifier">decode64</span>())
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Set</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">process</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>, <span class="ruby-identifier">selector</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">serialized?</span>()
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">reconstitute</span>(<span class="ruby-identifier">entry</span>)
|
||||
<span class="ruby-comment"># entry.unserialize()</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">entry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">entry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"unrecognized serialization format"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">raw_data</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">raw_data</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-shutdown" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">shutdown</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="shutdown-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 465</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">shutdown</span>()
|
||||
<span class="ruby-identifier">$Dispatcher</span>.<span class="ruby-identifier">shutdown</span>()
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">ZMQ</span><span class="ruby-operator">::</span><span class="ruby-identifier">zmq_default_context</span>.<span class="ruby-identifier">terminate</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-sql_statement-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">sql_statement?</span><span
|
||||
class="method-args">(the_string)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="sql_statement-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 569</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">sql_statement?</span>(<span class="ruby-identifier">the_string</span>)
|
||||
<span class="ruby-comment"># See: https://larrysteinle.com/2011/02/20/use-regular-expressions-to-detect-sql-code-injection/</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/('(''|[^'])*')|(;)|(\\x08(ALTER|CREATE|DELETE|DROP|EXEC(UTE){0,1}|INSERT( +INTO){0,1}|MERGE|SELECT|UPDATE|UNION( +ALL){0,1})\\x08)/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">the_string</span>)
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-c-uuid_generate" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">uuid_generate</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="uuid_generate-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 91</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">uuid_generate</span>()
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">SecureRandom</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-valid_domain_name-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">valid_domain_name?</span><span
|
||||
class="method-args">(the_string)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="valid_domain_name-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 578</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">valid_domain_name?</span>(<span class="ruby-identifier">the_string</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\.[a-zA-Z]{2,}$/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">the_string</span>)
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-c-valid_uuid-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">valid_uuid?</span><span
|
||||
class="method-args">(uuid=nil,strict=true)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="valid_uuid-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg.rb, line 548</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">valid_uuid?</span>(<span class="ruby-identifier">uuid</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">strict</span>=<span class="ruby-keyword">true</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">strict</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">pattern</span> = <span class="ruby-regexp">/[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[4][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]/</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">pattern</span> = <span class="ruby-regexp">/[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]/</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">pattern</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">36</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</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="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-find_local" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">find_local</span><span
|
||||
class="method-args">(the_key)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="find_local-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_entities.rb, line 6</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_local</span>(<span class="ruby-identifier">the_key</span>)
|
||||
<span class="ruby-keyword">nil</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>
|
||||
|
||||
5768
doc/GxG/ByteArray.html
Normal file
5768
doc/GxG/ByteArray.html
Normal file
File diff suppressed because it is too large
Load diff
253
doc/GxG/Communications.html
Normal file
253
doc/GxG/Communications.html
Normal file
|
|
@ -0,0 +1,253 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Communications - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-c-bridge">::bridge</a>
|
||||
|
||||
<li ><a href="#method-c-close_bridge">::close_bridge</a>
|
||||
|
||||
<li ><a href="#method-c-open_bridge">::open_bridge</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Communications">
|
||||
<h1 id="module-GxG::Communications" class="module">
|
||||
module GxG::Communications
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="BRIDGE_THREAD_SAFETY">BRIDGE_THREAD_SAFETY
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Class Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-c-bridge" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">bridge</span><span
|
||||
class="method-args">(the_uuid)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="bridge-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 7</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">bridge</span>(<span class="ruby-identifier">the_uuid</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">valid_uuid?</span>(<span class="ruby-identifier">the_uuid</span>)
|
||||
<span class="ruby-constant">BRIDGE_THREAD_SAFETY</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">BRIDGES</span>[(<span class="ruby-identifier">the_uuid</span>)] }
|
||||
<span class="ruby-keyword">else</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-close_bridge" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">close_bridge</span><span
|
||||
class="method-args">(the_uuid=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="close_bridge-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 21</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">close_bridge</span>(<span class="ruby-identifier">the_uuid</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">valid_uuid?</span>(<span class="ruby-identifier">the_uuid</span>)
|
||||
<span class="ruby-identifier">the_bridge</span> = <span class="ruby-constant">BRIDGE_THREAD_SAFETY</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">BRIDGES</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">the_uuid</span>) }
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_bridge</span>
|
||||
<span class="ruby-identifier">the_bridge</span>.<span class="ruby-identifier">close</span>
|
||||
<span class="ruby-identifier">timeout</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Chronic</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-string">"30 seconds from now"</span>).<span class="ruby-identifier">to_f</span>
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">the_bridge</span>.<span class="ruby-identifier">open?</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-identifier">sleep</span> <span class="ruby-value">1.0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">timeout</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-c-open_bridge" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">open_bridge</span><span
|
||||
class="method-args">(process=nil, the_url=nil, options=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="open_bridge-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 15</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">open_bridge</span>(<span class="ruby-identifier">process</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">new_bridge</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Communications</span><span class="ruby-operator">::</span><span class="ruby-constant">Bridge</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">process</span>, <span class="ruby-identifier">the_url</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-constant">BRIDGE_THREAD_SAFETY</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">BRIDGES</span>[(<span class="ruby-identifier">new_bridge</span>.<span class="ruby-identifier">uuid</span>)] = <span class="ruby-identifier">new_bridge</span> }
|
||||
<span class="ruby-identifier">new_bridge</span>.<span class="ruby-identifier">uuid</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>
|
||||
|
||||
509
doc/GxG/Communications/Bridge.html
Normal file
509
doc/GxG/Communications/Bridge.html
Normal file
|
|
@ -0,0 +1,509 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Communications::Bridge - 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-call_event">#call_event</a>
|
||||
|
||||
<li ><a href="#method-i-interface">#interface</a>
|
||||
|
||||
<li ><a href="#method-i-on">#on</a>
|
||||
|
||||
<li ><a href="#method-i-reply">#reply</a>
|
||||
|
||||
<li ><a href="#method-i-request">#request</a>
|
||||
|
||||
<li ><a href="#method-i-respond_to_event-3F">#respond_to_event?</a>
|
||||
|
||||
<li ><a href="#method-i-uuid">#uuid</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Communications::Bridge">
|
||||
<h1 id="class-GxG::Communications::Bridge" class="class">
|
||||
class GxG::Communications::Bridge
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(process=nil, the_url=nil, options=nil)</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/gxg/gxg_communications.rb, line 823</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">process</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-comment"># Note: process (required) is a Service or Application instance only</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">process</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Services</span><span class="ruby-operator">::</span><span class="ruby-constant">Service</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a Service or Application instance to bind to."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Ensure protocol supported</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">the_url</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-identifier">the_url</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URL as a String or URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">the_type</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">BRIDGES_AVAILABLE</span>[(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_sym</span>)]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_type</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Sorry, #{the_url.scheme.to_sym.inspect} is not a supported protocol."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Variables</span>
|
||||
<span class="ruby-ivar">@process</span> = <span class="ruby-identifier">process</span>
|
||||
<span class="ruby-ivar">@url</span> = <span class="ruby-identifier">the_url</span>
|
||||
<span class="ruby-ivar">@adapter</span> = <span class="ruby-identifier">the_type</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-ivar">@url</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-ivar">@uuid</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-ivar">@interface</span> = {}
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value">:interface</span>, <span class="ruby-string">"Available Commands"</span>) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">interface</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 id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-call_event" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">call_event</span><span
|
||||
class="method-args">(operation_envelope=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="call_event-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 869</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">call_event</span>(<span class="ruby-identifier">operation_envelope</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">operation_envelope</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">the_event</span> = <span class="ruby-identifier">operation_envelope</span>.<span class="ruby-identifier">keys</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_event</span>
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">operation_envelope</span>[(<span class="ruby-identifier">the_event</span>)]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@interface</span>[(<span class="ruby-identifier">the_event</span>)]
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:result</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@interface</span>[(<span class="ruby-identifier">the_event</span>)][<span class="ruby-value">:procedure</span>].<span class="ruby-identifier">call</span>(<span class="ruby-ivar">@process</span>, <span class="ruby-keyword">self</span>, <span class="ruby-identifier">data</span>)}
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:data</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">data</span>}})
|
||||
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:result</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>.<span class="ruby-identifier">to_s</span>}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:result</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-node">"Command #{the_event.inspect} Not Found"</span>}
|
||||
<span class="ruby-keyword">end</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>
|
||||
|
||||
|
||||
<div id="method-i-interface" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">interface</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="interface-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 890</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">interface</span>()
|
||||
<span class="ruby-identifier">result</span> = {}
|
||||
<span class="ruby-ivar">@interface</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_event</span>, <span class="ruby-identifier">the_record</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">result</span>[(<span class="ruby-identifier">the_event</span>)] = <span class="ruby-identifier">the_record</span>[<span class="ruby-value">:description</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-on" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">on</span><span
|
||||
class="method-args">(the_event, description=nil, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Command Interface</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="on-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 855</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">on</span>(<span class="ruby-identifier">the_event</span>, <span class="ruby-identifier">description</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_event</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You must specify an event listener with a unique Symbol."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You must provide an event code block to execute."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">description</span>
|
||||
<span class="ruby-identifier">description</span> = <span class="ruby-node">"{ '#{the_event.to_s}': '(your_data_payload)' }"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@interface</span>[(<span class="ruby-identifier">the_event</span>)] = {<span class="ruby-value">:description</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">description</span>, <span class="ruby-value">:procedure</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">block</span>}
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-reply" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">reply</span><span
|
||||
class="method-args">(the_channel_uuid=nil, reply_body=nil, address=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="reply-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 947</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reply</span>(<span class="ruby-identifier">the_channel_uuid</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reply_body</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">address</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:result</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">valid_uuid?</span>(<span class="ruby-identifier">the_channel_uuid</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">reply_body</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Events</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">address</span>
|
||||
<span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-identifier">the_channel_uuid</span>, <span class="ruby-identifier">reply_body</span>, <span class="ruby-identifier">address</span>)
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">:result</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-request" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">request</span><span
|
||||
class="method-args">(the_channel_uuid=nil, request_body=nil, address=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Request/Reply <a href="../Support.html"><code>Support</code></a></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="request-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 908</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">request</span>(<span class="ruby-identifier">the_channel_uuid</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">request_body</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">address</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">valid_uuid?</span>(<span class="ruby-identifier">the_channel_uuid</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">request_body</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Events</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">address</span>
|
||||
<span class="ruby-identifier">payload</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">context</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">address</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">valid_jid?</span>
|
||||
<span class="ruby-comment"># Point-to-Point Request</span>
|
||||
<span class="ruby-identifier">payload</span> = <span class="ruby-identifier">new_message</span>({<span class="ruby-value">:sender</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">jid</span>().<span class="ruby-identifier">to_s</span>, <span class="ruby-value">:body</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">request_body</span>})
|
||||
<span class="ruby-identifier">payload</span>[<span class="ruby-value">:context</span>] = <span class="ruby-identifier">context</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">payload</span>
|
||||
<span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-identifier">the_channel_uuid</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">address</span>)
|
||||
<span class="ruby-identifier">the_reply_list</span> = <span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">get_messages_by_context</span>(<span class="ruby-identifier">the_channel_uuid</span>, <span class="ruby-identifier">context</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">timeout</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>].<span class="ruby-identifier">to_f</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">timeout</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">+</span> <span class="ruby-value">30.0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">timeout</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">+</span> <span class="ruby-value">30.0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">until</span> <span class="ruby-identifier">the_reply_list</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-identifier">the_reply_list</span> = <span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">get_messages_by_context</span>(<span class="ruby-identifier">the_channel_uuid</span>, <span class="ruby-identifier">context</span>)
|
||||
<span class="ruby-identifier">sleep</span> <span class="ruby-value">0.5</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">timeout</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_reply_list</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">the_reply_list</span>[<span class="ruby-value">0</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-comment">#</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-respond_to_event-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">respond_to_event?</span><span
|
||||
class="method-args">(the_event=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="respond_to_event-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 898</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">respond_to_event?</span>(<span class="ruby-identifier">the_event</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_event</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@interface</span>[(<span class="ruby-identifier">the_event</span>)]
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-i-uuid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">uuid</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="uuid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 851</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uuid</span>()
|
||||
<span class="ruby-ivar">@uuid</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>
|
||||
|
||||
654
doc/GxG/Communications/BridgeAdapter.html
Normal file
654
doc/GxG/Communications/BridgeAdapter.html
Normal file
|
|
@ -0,0 +1,654 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Communications::BridgeAdapter - 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-abilities">::abilities</a>
|
||||
|
||||
<li ><a href="#method-c-limits">::limits</a>
|
||||
|
||||
<li ><a href="#method-c-new">::new</a>
|
||||
|
||||
<li ><a href="#method-c-protocol">::protocol</a>
|
||||
|
||||
<li ><a href="#method-c-templates">::templates</a>
|
||||
|
||||
<li ><a href="#method-i-channels">#channels</a>
|
||||
|
||||
<li ><a href="#method-i-close">#close</a>
|
||||
|
||||
<li ><a href="#method-i-entitiies">#entitiies</a>
|
||||
|
||||
<li ><a href="#method-i-entity_status">#entity_status</a>
|
||||
|
||||
<li ><a href="#method-i-my_id">#my_id</a>
|
||||
|
||||
<li ><a href="#method-i-notify">#notify</a>
|
||||
|
||||
<li ><a href="#method-i-open">#open</a>
|
||||
|
||||
<li ><a href="#method-i-open-3F">#open?</a>
|
||||
|
||||
<li ><a href="#method-i-uuid">#uuid</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Communications::BridgeAdapter">
|
||||
<h1 id="class-GxG::Communications::BridgeAdapter" class="class">
|
||||
class GxG::Communications::BridgeAdapter
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>Adapters</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-abilities" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">abilities</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="abilities-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 46</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">abilities</span>()
|
||||
[]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-limits" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">limits</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="limits-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 50</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">limits</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">(the_process=nil, the_url=nil, options=nil)</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/gxg/gxg_communications.rb, line 58</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">the_process</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">the_url</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-identifier">the_url</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URL as a String or URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_process</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a Service or Application object to interact with."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@process</span> = <span class="ruby-identifier">the_process</span>
|
||||
<span class="ruby-ivar">@url</span> = <span class="ruby-identifier">the_url</span>
|
||||
<span class="ruby-ivar">@options</span> = (<span class="ruby-identifier">options</span> <span class="ruby-operator">||</span> {})
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You must provide options as a Hash."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@thread_safety</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-ivar">@uuid</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-protocol" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">protocol</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>WARNING: Only instantiate subclasses</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="protocol-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 42</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">protocol</span>()
|
||||
<span class="ruby-value">:unspecified</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-templates" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">templates</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="templates-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 54</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">templates</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-channels" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">channels</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Basic Channel <a href="../Support.html"><code>Support</code></a></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="channels-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 129</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">channels</span>()
|
||||
{}
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-close" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">close</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="close-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 108</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">open?</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">logout</span>()
|
||||
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-entitiies" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">entitiies</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Basic <a href="../Entity.html"><code>Entity</code></a> <a href="../Support.html"><code>Support</code></a></p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="entitiies-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 121</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entitiies</span>()
|
||||
[]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-entity_status" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">entity_status</span><span
|
||||
class="method-args">(the_address=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="entity_status-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 125</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entity_status</span>(<span class="ruby-identifier">the_address</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-value">:online</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-my_id" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">my_id</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="my_id-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 86</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">my_id</span>()
|
||||
<span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-notify" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">notify</span><span
|
||||
class="method-args">(details=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Information Refresh</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="notify-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 116</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notify</span>(<span class="ruby-identifier">details</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-open" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">open</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="open-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 101</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">open</span>()
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">open?</span>
|
||||
<span class="ruby-ivar">@active</span> = <span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">login</span>(<span class="ruby-ivar">@url</span>, <span class="ruby-ivar">@options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@active</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-open-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">open?</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="open-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 90</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">open?</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@connector</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">closed?</span>
|
||||
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@active</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-uuid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">uuid</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="uuid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 82</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uuid</span>()
|
||||
<span class="ruby-ivar">@uuid</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>
|
||||
|
||||
1688
doc/GxG/Communications/BridgeAdapterXMPP.html
Normal file
1688
doc/GxG/Communications/BridgeAdapterXMPP.html
Normal file
File diff suppressed because it is too large
Load diff
194
doc/GxG/Database.html
Normal file
194
doc/GxG/Database.html
Normal file
|
|
@ -0,0 +1,194 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Database - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-c-connect">::connect</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Database">
|
||||
<h1 id="module-GxG::Database" class="module">
|
||||
module GxG::Database
|
||||
</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-connect" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">connect</span><span
|
||||
class="method-args">(the_url, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="connect-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_database.rb, line 10</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">connect</span>(<span class="ruby-identifier">the_url</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-comment"># TODO: require :credential (access privs)</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># check for URI ipv6 [format] compatibility</span>
|
||||
<span class="ruby-identifier">db_url</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-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-identifier">the_path</span> = <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_path</span> <span class="ruby-operator">==</span> <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">the_path</span> = <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">RUBY_ENGINE</span> <span class="ruby-operator">==</span> <span class="ruby-string">"jruby"</span>
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:sqlite</span>, <span class="ruby-value">:sqlite3</span>
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-string">"/memory"</span>, <span class="ruby-string">"memory"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"jdbc:sqlite::memory:"</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"jdbc:sqlite:"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>({<span class="ruby-value">:adapter</span> <span class="ruby-operator">=></span> (<span class="ruby-string">"jdbc:"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:database</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">last</span>), <span class="ruby-value">:user</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">password</span>.<span class="ruby-identifier">to_s</span>)})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:sqlite</span>, <span class="ruby-value">:sqlite3</span>
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-string">"/memory"</span>, <span class="ruby-string">"memory"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"sqlite::memory:"</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>(<span class="ruby-string">"sqlite://"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># auto-forward to mysql2 gem if mysql:// scheme</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-string">"mysql"</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>({<span class="ruby-value">:adapter</span> <span class="ruby-operator">=></span> <span class="ruby-string">"mysql2"</span>, <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:database</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">last</span>), <span class="ruby-value">:user</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">password</span>.<span class="ruby-identifier">to_s</span>)})
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Sequel</span>.<span class="ruby-identifier">connect</span>({<span class="ruby-value">:adapter</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:host</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">hostname</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:database</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"/"</span>).<span class="ruby-identifier">last</span>), <span class="ruby-value">:user</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">to_s</span>), <span class="ruby-value">:password</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>.<span class="ruby-identifier">password</span>.<span class="ruby-identifier">to_s</span>)})
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">db_url</span>)}))
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_url</span>), <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">options</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>
|
||||
|
||||
8853
doc/GxG/Database/Database.html
Normal file
8853
doc/GxG/Database/Database.html
Normal file
File diff suppressed because it is too large
Load diff
106
doc/GxG/Database/ExternalAuthority.html
Normal file
106
doc/GxG/Database/ExternalAuthority.html
Normal file
|
|
@ -0,0 +1,106 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Database::ExternalAuthority - 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>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Database::ExternalAuthority">
|
||||
<h1 id="class-GxG::Database::ExternalAuthority" class="class">
|
||||
class GxG::Database::ExternalAuthority
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>External Authority (Such as LDAP)</p>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
104
doc/GxG/Database/LDAPAuthority.html
Normal file
104
doc/GxG/Database/LDAPAuthority.html
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Database::LDAPAuthority - 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="ExternalAuthority.html">GxG::Database::ExternalAuthority</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Database::LDAPAuthority">
|
||||
<h1 id="class-GxG::Database::LDAPAuthority" class="class">
|
||||
class GxG::Database::LDAPAuthority
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
3354
doc/GxG/Database/PersistedArray.html
Normal file
3354
doc/GxG/Database/PersistedArray.html
Normal file
File diff suppressed because it is too large
Load diff
3334
doc/GxG/Database/PersistedHash.html
Normal file
3334
doc/GxG/Database/PersistedHash.html
Normal file
File diff suppressed because it is too large
Load diff
3067
doc/GxG/Engine.html
Normal file
3067
doc/GxG/Engine.html
Normal file
File diff suppressed because it is too large
Load diff
97
doc/GxG/Entity.html
Normal file
97
doc/GxG/Entity.html
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Entity - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Entity">
|
||||
<h1 id="module-GxG::Entity" class="module">
|
||||
module GxG::Entity
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
2779
doc/GxG/Entity/LocalSystem.html
Normal file
2779
doc/GxG/Entity/LocalSystem.html
Normal file
File diff suppressed because it is too large
Load diff
104
doc/GxG/Entity/RemoteSystem.html
Normal file
104
doc/GxG/Entity/RemoteSystem.html
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Entity::RemoteSystem - 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>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Entity::RemoteSystem">
|
||||
<h1 id="class-GxG::Entity::RemoteSystem" class="class">
|
||||
class GxG::Entity::RemoteSystem
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
517
doc/GxG/Enumerator.html
Normal file
517
doc/GxG/Enumerator.html
Normal file
|
|
@ -0,0 +1,517 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Enumerator - 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">Enumerator
|
||||
|
||||
</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-each">#each</a>
|
||||
|
||||
<li ><a href="#method-i-each_with_index">#each_with_index</a>
|
||||
|
||||
<li ><a href="#method-i-next">#next</a>
|
||||
|
||||
<li ><a href="#method-i-next_values">#next_values</a>
|
||||
|
||||
<li ><a href="#method-i-peek">#peek</a>
|
||||
|
||||
<li ><a href="#method-i-peek_values">#peek_values</a>
|
||||
|
||||
<li ><a href="#method-i-rewind">#rewind</a>
|
||||
|
||||
<li ><a href="#method-i-with_index">#with_index</a>
|
||||
|
||||
<li ><a href="#method-i-with_object">#with_object</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Enumerator">
|
||||
<h1 id="class-GxG::Enumerator" class="class">
|
||||
class GxG::Enumerator
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(object=nil,method=:each,*args, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>this is a bit inefficient, but it gets the job done. It is essentially an each wrapper to do a cooperative pauses for non-blocking goodness. :) TODO: inspiration: what about just leveraging 'super' after a pause operation on all overrides. (thx)</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 282</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">object</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">method</span>=<span class="ruby-value">:each</span>,<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-comment"># Without the call to super() it works, but will be uninitialized</span>
|
||||
<span class="ruby-comment"># super(object,method,*args)</span>
|
||||
<span class="ruby-ivar">@collection</span> = <span class="ruby-identifier">object</span>.<span class="ruby-identifier">stock_to_enum</span>(<span class="ruby-identifier">method</span>,<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-comment"># @collection = ::Enumerator.new(object,method,*args,&block)</span>
|
||||
<span class="ruby-keyword">self</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-each" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">each</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="each-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 290</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-comment"># reference = {:object => self, :method => __callee__, :fiber => Fiber.current, :thread => Thread.current}</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">EventManager</span><span class="ruby-operator">::</span><span class="ruby-identifier">manager_running?</span>
|
||||
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-operator">*</span><span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-each_with_index" class="method-detail method-alias">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">each_with_index</span><span
|
||||
class="method-args">(offset=0,&block)</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Alias for: <a href="Enumerator.html#method-i-with_index">with_index</a>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-next" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">next</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="next-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 308</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">next</span>()
|
||||
<span class="ruby-identifier ruby-title">pause</span>
|
||||
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">next</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-next_values" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">next_values</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="next_values-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 313</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">next_values</span>()
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">next_values</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-peek" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">peek</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="peek-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 318</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">peek</span>()
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">peek</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-peek_values" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">peek_values</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="peek_values-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 323</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">peek_values</span>()
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">peek_values</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-rewind" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">rewind</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="rewind-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 328</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rewind</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:rewind</span>)
|
||||
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">rewind</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-with_index" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">with_index</span><span
|
||||
class="method-args">(offset=0,&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="with_index-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 335</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_index</span>(<span class="ruby-identifier">offset</span>=<span class="ruby-value">0</span>,<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">enumerator</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Enumerator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">with_index</span>(<span class="ruby-identifier">offset</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">enumerator</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>,<span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">entry</span>,<span class="ruby-identifier">index</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">enumerator</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="aliases">
|
||||
Also aliased as: <a href="Enumerator.html#method-i-each_with_index">each_with_index</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-with_object" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">with_object</span><span
|
||||
class="method-args">(an_object=nil,&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="with_object-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 347</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_object</span>(<span class="ruby-identifier">an_object</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">enumerator</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Enumerator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">with_object</span>(<span class="ruby-identifier">an_object</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">enumerator</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>,<span class="ruby-identifier">the_object</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">entry</span>,<span class="ruby-identifier">the_object</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">an_object</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">enumerator</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.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>
|
||||
|
||||
152
doc/GxG/EventManager.html
Normal file
152
doc/GxG/EventManager.html
Normal file
|
|
@ -0,0 +1,152 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::EventManager - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-c-manager_running-3F">::manager_running?</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::EventManager">
|
||||
<h1 id="module-GxG::EventManager" class="module">
|
||||
module GxG::EventManager
|
||||
</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-manager_running-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">manager_running?</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="manager_running-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 510</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">manager_running?</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">$Dispatcher</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">$Dispatcher</span>.<span class="ruby-identifier">running?</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>
|
||||
|
||||
97
doc/GxG/Events.html
Normal file
97
doc/GxG/Events.html
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Events - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Events">
|
||||
<h1 id="module-GxG::Events" class="module">
|
||||
module GxG::Events
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
1110
doc/GxG/Events/EventDispatcher.html
Normal file
1110
doc/GxG/Events/EventDispatcher.html
Normal file
File diff suppressed because it is too large
Load diff
104
doc/GxG/Events/LoggerDB.html
Normal file
104
doc/GxG/Events/LoggerDB.html
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Events::LoggerDB - 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>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Events::LoggerDB">
|
||||
<h1 id="class-GxG::Events::LoggerDB" class="class">
|
||||
class GxG::Events::LoggerDB
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
824
doc/GxG/Events/Message.html
Normal file
824
doc/GxG/Events/Message.html
Normal file
|
|
@ -0,0 +1,824 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Events::Message - 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-5B-5D">#[]</a>
|
||||
|
||||
<li ><a href="#method-i-5B-5D-3D">#[]=</a>
|
||||
|
||||
<li ><a href="#method-i-body">#body</a>
|
||||
|
||||
<li ><a href="#method-i-compose_reply">#compose_reply</a>
|
||||
|
||||
<li ><a href="#method-i-fail">#fail</a>
|
||||
|
||||
<li ><a href="#method-i-get_at_path">#get_at_path</a>
|
||||
|
||||
<li ><a href="#method-i-id">#id</a>
|
||||
|
||||
<li ><a href="#method-i-inspect">#inspect</a>
|
||||
|
||||
<li ><a href="#method-i-keys">#keys</a>
|
||||
|
||||
<li ><a href="#method-i-on">#on</a>
|
||||
|
||||
<li ><a href="#method-i-paths_to">#paths_to</a>
|
||||
|
||||
<li ><a href="#method-i-process">#process</a>
|
||||
|
||||
<li ><a href="#method-i-process-21">#process!</a>
|
||||
|
||||
<li ><a href="#method-i-search">#search</a>
|
||||
|
||||
<li ><a href="#method-i-sender">#sender</a>
|
||||
|
||||
<li ><a href="#method-i-set_at_path">#set_at_path</a>
|
||||
|
||||
<li ><a href="#method-i-subject">#subject</a>
|
||||
|
||||
<li ><a href="#method-i-succeed">#succeed</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Events::Message">
|
||||
<h1 id="class-GxG::Events::Message" class="class">
|
||||
class GxG::Events::Message
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</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="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 7</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-comment"># MUST provide a hash with at least :sender message field set</span>
|
||||
<span class="ruby-comment"># {:sender => <some-object>, :body => <some-object>, :on_success => <some-proc>, :on_fail => <some-proc> }</span>
|
||||
<span class="ruby-keyword">unless</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">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you must pass a Hash to create the message"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@data</span> = {<span class="ruby-value">:sender</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:id</span> <span class="ruby-operator">=></span> (<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>().<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>), <span class="ruby-value">:subject</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>], <span class="ruby-value">:body</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:on_success</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:on_fail</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">:sender</span>]
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you must set the :sender key in the argument Hash"</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 id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-5B-5D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">[]</span><span
|
||||
class="method-args">(the_key)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="5B-5D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 81</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">the_key</span>)
|
||||
<span class="ruby-ivar">@data</span>[(<span class="ruby-identifier">the_key</span>)]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-5B-5D-3D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">[]=</span><span
|
||||
class="method-args">(the_key, the_value)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="5B-5D-3D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 84</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span>(<span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span>)
|
||||
<span class="ruby-ivar">@data</span>[(<span class="ruby-identifier">the_key</span>)] = <span class="ruby-identifier">the_value</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-body" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">body</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="body-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 36</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">body</span>()
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:body</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-compose_reply" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">compose_reply</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="compose_reply-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 40</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">compose_reply</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">reply_message</span> = <span class="ruby-identifier">new_message</span>({<span class="ruby-value">:sender</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:to</span>], <span class="ruby-value">:to</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:sender</span>], <span class="ruby-value">:context</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:context</span>], <span class="ruby-value">:subject</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:subject</span>], <span class="ruby-value">:body</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">self</span>[<span class="ruby-value">:body</span>]})
|
||||
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">reply_message</span>)
|
||||
<span class="ruby-keyword">else</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-i-fail" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">fail</span><span
|
||||
class="method-args">(input=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="fail-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 55</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fail</span>(<span class="ruby-identifier">input</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_fail</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_fail</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">input</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-get_at_path" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get_at_path</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="get_at_path-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 99</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">get_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-id" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">id</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="id-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 24</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">id</span>()
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:id</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-inspect" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">inspect</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="inspect-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 20</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>()
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">inspect</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-keys" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">keys</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Hash-like support methods:</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="keys-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 78</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">keys</span>()
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">keys</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-on" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">on</span><span
|
||||
class="method-args">(event_type=nil,&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="on-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 61</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">on</span>(<span class="ruby-identifier">event_type</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-value">:success</span>, <span class="ruby-value">:fail</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">event_type</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-keyword">case</span> <span class="ruby-identifier">event_type</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:success</span>
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_success</span>] = <span class="ruby-identifier">block</span>
|
||||
<span class="ruby-keyword">when</span> <span class="ruby-value">:fail</span>
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_fail</span>] = <span class="ruby-identifier">block</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a callable block."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Unknown event type: #{event_type}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-paths_to" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">paths_to</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="paths_to-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 96</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">paths_to</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">paths_to</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 87</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">process</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process-21" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process!</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process-21-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 90</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">process!</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-search" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">search</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="search-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 93</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">search</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-sender" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">sender</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="sender-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 28</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sender</span>()
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:sender</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-set_at_path" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">set_at_path</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="set_at_path-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 102</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">set_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-ivar">@data</span>.<span class="ruby-identifier">set_at_path</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-subject" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">subject</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="subject-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 32</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subject</span>()
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:subject</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-succeed" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">succeed</span><span
|
||||
class="method-args">(input=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="succeed-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_events.rb, line 49</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">succeed</span>(<span class="ruby-identifier">input</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_success</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@data</span>[<span class="ruby-value">:on_success</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">input</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.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>
|
||||
|
||||
97
doc/GxG/IO.html
Normal file
97
doc/GxG/IO.html
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::IO - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::IO">
|
||||
<h1 id="module-GxG::IO" class="module">
|
||||
module GxG::IO
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
171
doc/GxG/IO/Duplex.html
Normal file
171
doc/GxG/IO/Duplex.html
Normal file
|
|
@ -0,0 +1,171 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::IO::Duplex - 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="IO.html">GxG::IO::IO</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::IO::Duplex">
|
||||
<h1 id="class-GxG::IO::Duplex" class="class">
|
||||
class GxG::IO::Duplex
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</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-calls-super">
|
||||
Calls superclass method
|
||||
<a href="IO.html#method-c-new"><code>GxG::IO::IO::new</code></a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 2541</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_parameters</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:read</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:read</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:readwrite</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:readwrite</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">params</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.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>
|
||||
|
||||
347
doc/GxG/IO/File.html
Normal file
347
doc/GxG/IO/File.html
Normal file
|
|
@ -0,0 +1,347 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::IO::File - 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="IO.html">GxG::IO::IO</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-i-to_path">#to_path</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::IO::File">
|
||||
<h1 id="class-GxG::IO::File" class="class">
|
||||
class GxG::IO::File
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(*args)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>As of Ruby 1.9.2: if a file is not set to :binary mode, it defaults to :text mode. See: <a href="http://www.tutorialspoint.com/ruby/ruby_input_output.htm">www.tutorialspoint.com/ruby/ruby_input_output.htm</a> <file>.stat table: (mode example : 0100664)</p>
|
||||
|
||||
<pre>0700 rwx mask for owner
|
||||
0400 r for owner
|
||||
0200 w for owner
|
||||
0100 x for owner
|
||||
0070 rwx mask for group
|
||||
0040 r for group
|
||||
0020 w for group
|
||||
0010 x for group
|
||||
0007 rwx mask for other
|
||||
0004 r for other
|
||||
0002 w for other
|
||||
0001 x for other
|
||||
4000 Set user ID on execution
|
||||
2000 Set group ID on execution
|
||||
1000 Save swapped text, even after use</pre>
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
<a href="IO.html#method-c-new"><code>GxG::IO::IO::new</code></a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 2577</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</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-constant">String</span>)
|
||||
<span class="ruby-identifier">the_path</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-identifier">the_mode</span> = (<span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">||</span> <span class="ruby-string">"r"</span>)
|
||||
<span class="ruby-identifier">the_permissions</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>]
|
||||
<span class="ruby-identifier">the_options</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">3</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"filename or path must be passed as a String"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_options</span>
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_parameters</span>(<span class="ruby-value">0</span>,<span class="ruby-identifier">the_mode</span>,<span class="ruby-identifier">the_options</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_parameters</span>(<span class="ruby-value">0</span>,<span class="ruby-identifier">the_mode</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">mode_flags</span> = {<span class="ruby-value">:binary</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">BINARY</span>, <span class="ruby-value">:text</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">TEXT</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">RDONLY</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">WRONLY</span>, <span class="ruby-value">:readwrite</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">RDWR</span>, <span class="ruby-value">:create</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">CREAT</span>, <span class="ruby-value">:overwrite</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">TRUNC</span>, <span class="ruby-value">:append</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">APPEND</span>}
|
||||
<span class="ruby-identifier">modes</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">valid_mode_set</span>({<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-value">:file</span>, <span class="ruby-value">:read</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:write</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:text</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:binary</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-identifier">the_mode_used</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">mode_string</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:binary</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:read</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-identifier">mode_string</span> = <span class="ruby-string">"binary_readwrite"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:binary</span>] <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:readwrite</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">mode_string</span> = <span class="ruby-string">"binary_read"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:binary</span>] <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:read</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-identifier">mode_string</span> = <span class="ruby-string">"binary_write"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:binary</span>] <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:write</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">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:read</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-identifier">mode_string</span> = <span class="ruby-string">"text_readwrite"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:text</span>] <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:readwrite</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">mode_string</span> = <span class="ruby-string">"text_read"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:text</span>] <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:read</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-identifier">mode_string</span> = <span class="ruby-string">"text_write"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:text</span>] <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:write</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:overwrite</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:truncate</span>) )
|
||||
<span class="ruby-identifier">mode_string</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"_overwrite"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:overwrite</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:append</span>)
|
||||
<span class="ruby-identifier">mode_string</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"_append"</span>
|
||||
<span class="ruby-identifier">mode_numeric</span> = (<span class="ruby-identifier">mode_numeric</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">mode_flags</span>[<span class="ruby-value">:append</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># [:read, :write, :readwrite, :overwrite, :truncate:, :append, :text, :binary]</span>
|
||||
<span class="ruby-identifier">modes</span>.<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">mode_entry</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">mode_entry</span>[<span class="ruby-value">:synonyms</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">mode_string</span>.<span class="ruby-identifier">to_sym</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">mode_entry</span>[<span class="ruby-value">:synonyms</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">mode_numeric</span>))
|
||||
<span class="ruby-identifier">the_mode_used</span> = <span class="ruby-identifier">mode_entry</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_mode_used</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-identifier">the_mode</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:external_encoding</span>]
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:external_encoding</span>] = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:external_encoding</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:internal_encoding</span>]
|
||||
<span class="ruby-comment">#If the value is nil no conversion occurs.</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:internal_encoding</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:external_encoding</span>]
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:internal_encoding</span>] = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:internal_encoding</span>] = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:internal_encoding</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:autoclose</span>]
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:autoclose</span>] = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:autoclose</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-identifier">the_mode</span> = <span class="ruby-identifier">the_mode_used</span>[<span class="ruby-value">:if_exist</span>].<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_mode_used</span>[<span class="ruby-value">:if_create</span>]
|
||||
<span class="ruby-identifier">the_mode</span> = <span class="ruby-identifier">the_mode_used</span>[<span class="ruby-value">:if_create</span>].<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you cannot operate upon a non-existent file in read-only mode"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_mode</span>
|
||||
<span class="ruby-identifier">file_descriptor</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">sysopen</span>(<span class="ruby-identifier">the_path</span>,<span class="ruby-identifier">the_mode</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">file_descriptor</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">file_descriptor</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you cannot operate upon a directory as if it were a file"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_permissions</span>
|
||||
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">file_descriptor</span>, <span class="ruby-identifier">the_mode</span>, <span class="ruby-identifier">the_permissions</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">file_descriptor</span>, <span class="ruby-identifier">the_mode</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"unable to create a valid file descriptor with: #{args.inspect}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">modes_list</span> = []
|
||||
<span class="ruby-identifier">modes</span>.<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">item</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">modes_list</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">item</span>[<span class="ruby-value">:synonyms</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"#{params[:mode].inspect} is an invalid :mode, use one of the following: #{modes_list.inspect}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-ivar">@path</span> = <span class="ruby-identifier">the_path</span>
|
||||
<span class="ruby-keyword">self</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-to_path" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">to_path</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="to_path-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 2709</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_path</span>()
|
||||
<span class="ruby-ivar">@path</span>.<span class="ruby-identifier">dup</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>
|
||||
|
||||
1228
doc/GxG/IO/IO.html
Normal file
1228
doc/GxG/IO/IO.html
Normal file
File diff suppressed because it is too large
Load diff
168
doc/GxG/IO/Input.html
Normal file
168
doc/GxG/IO/Input.html
Normal file
|
|
@ -0,0 +1,168 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::IO::Input - 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="IO.html">GxG::IO::IO</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::IO::Input">
|
||||
<h1 id="class-GxG::IO::Input" class="class">
|
||||
class GxG::IO::Input
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(*args)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>ensure mode is read-only, else raise Exception</p>
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
<a href="IO.html#method-c-new"><code>GxG::IO::IO::new</code></a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 2509</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_parameters</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:readwrite</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:readwrite</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">params</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.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>
|
||||
|
||||
171
doc/GxG/IO/Output.html
Normal file
171
doc/GxG/IO/Output.html
Normal file
|
|
@ -0,0 +1,171 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::IO::Output - 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="IO.html">GxG::IO::IO</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::IO::Output">
|
||||
<h1 id="class-GxG::IO::Output" class="class">
|
||||
class GxG::IO::Output
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(*args)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>ensure mode is write-only, else raise Exception</p>
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
<a href="IO.html#method-c-new"><code>GxG::IO::IO::new</code></a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 2524</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_parameters</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:read</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:read</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:readwrite</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:readwrite</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:write</span>)
|
||||
<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">params</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.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>
|
||||
|
||||
1284
doc/GxG/IO/StringIO.html
Normal file
1284
doc/GxG/IO/StringIO.html
Normal file
File diff suppressed because it is too large
Load diff
386
doc/GxG/Networking.html
Normal file
386
doc/GxG/Networking.html
Normal file
|
|
@ -0,0 +1,386 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Networking - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-c-get_handler_class">::get_handler_class</a>
|
||||
|
||||
<li ><a href="#method-c-register_handler_class">::register_handler_class</a>
|
||||
|
||||
<li ><a href="#method-c-registered_protocols">::registered_protocols</a>
|
||||
|
||||
<li ><a href="#method-c-unregister_handler_class">::unregister_handler_class</a>
|
||||
|
||||
<li ><a href="#method-c-wget">::wget</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Networking">
|
||||
<h1 id="module-GxG::Networking" class="module">
|
||||
module GxG::Networking
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="constants-list">
|
||||
<header>
|
||||
<h3>Constants</h3>
|
||||
</header>
|
||||
<dl>
|
||||
|
||||
<dt id="REGISTERED">REGISTERED
|
||||
|
||||
<dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Class Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-c-get_handler_class" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get_handler_class</span><span
|
||||
class="method-args">(the_url=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="get_handler_class-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_tools.rb, line 11</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">get_handler_class</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</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">@@protocol_thread_safety</span>.<span class="ruby-identifier">synchronize</span> {
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">REGISTERED</span>[<span class="ruby-value">:protocols</span>].<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_scheme</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">the_scheme</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">REGISTERED</span>[<span class="ruby-value">:protocols</span>][(<span class="ruby-identifier">the_scheme</span>)]
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-register_handler_class" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">register_handler_class</span><span
|
||||
class="method-args">(the_scheme=nil, the_class=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="register_handler_class-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_tools.rb, line 32</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">register_handler_class</span>(<span class="ruby-identifier">the_scheme</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_class</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_class</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Class</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid class."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_scheme</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI scheme (as a String or Symbol)."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">@@protocol_thread_safety</span>.<span class="ruby-identifier">synchronize</span> {
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">REGISTERED</span>[<span class="ruby-value">:protocols</span>][(<span class="ruby-identifier">the_scheme</span>.<span class="ruby-identifier">to_sym</span>)] = <span class="ruby-identifier">the_class</span>
|
||||
}
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:scheme</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_scheme</span>, <span class="ruby-value">:class</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_class</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-registered_protocols" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">registered_protocols</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="registered_protocols-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_tools.rb, line 67</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">registered_protocols</span>()
|
||||
<span class="ruby-identifier">@@protocol_thread_safety</span>.<span class="ruby-identifier">synchronize</span> {
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">REGISTERED</span>[<span class="ruby-value">:protocols</span>].<span class="ruby-identifier">clone</span>
|
||||
}
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-unregister_handler_class" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">unregister_handler_class</span><span
|
||||
class="method-args">(the_scheme=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="unregister_handler_class-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_tools.rb, line 51</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">unregister_handler_class</span>(<span class="ruby-identifier">the_scheme</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_scheme</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI scheme (as a String or Symbol)."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">@@protocol_thread_safety</span>.<span class="ruby-identifier">synchronize</span> {
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">REGISTERED</span>[<span class="ruby-value">:protocols</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">the_scheme</span>.<span class="ruby-identifier">to_sym</span>)
|
||||
}
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:scheme</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_scheme</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-wget" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">wget</span><span
|
||||
class="method-args">(the_url=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="wget-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_tools.rb, line 73</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">wget</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">the_url</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-identifier">the_url</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</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-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>]
|
||||
<span class="ruby-identifier">client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">HttpsClientWithPem</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>]
|
||||
<span class="ruby-identifier">client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">HttpsClient</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">HttpClient</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">the_url</span>, <span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:raw_response</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>}))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:raw_response</span>]
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to get a response."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST specify a valid URI"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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>
|
||||
|
||||
1120
doc/GxG/Networking/FtpClient.html
Normal file
1120
doc/GxG/Networking/FtpClient.html
Normal file
File diff suppressed because it is too large
Load diff
848
doc/GxG/Networking/HttpClient.html
Normal file
848
doc/GxG/Networking/HttpClient.html
Normal file
|
|
@ -0,0 +1,848 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::HttpClient - 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-clear_cache">#clear_cache</a>
|
||||
|
||||
<li ><a href="#method-i-cookies">#cookies</a>
|
||||
|
||||
<li ><a href="#method-i-delete">#delete</a>
|
||||
|
||||
<li ><a href="#method-i-get">#get</a>
|
||||
|
||||
<li ><a href="#method-i-post">#post</a>
|
||||
|
||||
<li ><a href="#method-i-put">#put</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::HttpClient">
|
||||
<h1 id="class-GxG::Networking::HttpClient" class="class">
|
||||
class GxG::Networking::HttpClient
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</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="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5228</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
||||
<span class="ruby-ivar">@cookie</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">self</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-clear_cache" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">clear_cache</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="clear_cache-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5233</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear_cache</span>()
|
||||
<span class="ruby-ivar">@cookie</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-cookies" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">cookies</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="cookies-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5238</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cookies</span>()
|
||||
<span class="ruby-ivar">@cookie</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-delete" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">delete</span><span
|
||||
class="method-args">(the_url=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="delete-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5635</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPS</span>)
|
||||
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span>)]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">host</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">port</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">server</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-comment"># basic auth</span>
|
||||
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
||||
<span class="ruby-comment"># Process Redirect</span>
|
||||
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-get" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get</span><span
|
||||
class="method-args">(the_url=nil, options={:follow_redirects => true})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="get-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5242</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={<span class="ruby-value">:follow_redirects</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPS</span>)
|
||||
<span class="ruby-identifier">the_url</span> = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">dup</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:query</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">query</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span>.<span class="ruby-identifier">encode_www_form</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:query</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:follow_redirects</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># sets following values by its accessor.</span>
|
||||
<span class="ruby-comment"># The keys are ca_file, ca_path, cert, cert_store, ciphers,</span>
|
||||
<span class="ruby-comment"># close_on_empty_response, key, open_timeout, read_timeout, ssl_timeout,</span>
|
||||
<span class="ruby-comment"># ssl_version, use_ssl, verify_callback, verify_depth and verify_mode.</span>
|
||||
<span class="ruby-comment"># If you set :use_ssl as true, you can use https and default value of</span>
|
||||
<span class="ruby-comment"># verify_mode is set as OpenSSL::SSL::VERIFY_PEER.</span>
|
||||
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span>)]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">host</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">port</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">client</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
||||
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
||||
<span class="ruby-identifier">client</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>]))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:header</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-comment"># basic auth</span>
|
||||
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
||||
<span class="ruby-ivar">@cookie</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">response</span>[<span class="ruby-string">'set-cookie'</span>]
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
||||
<span class="ruby-comment"># Process Redirect</span>
|
||||
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
||||
<span class="ruby-ivar">@cookie</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">response</span>[<span class="ruby-string">'set-cookie'</span>]
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-ivar">@cookie</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">response</span>[<span class="ruby-string">'set-cookie'</span>]
|
||||
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>].<span class="ruby-identifier">to_s</span>, <span class="ruby-string">'w'</span>, <span class="ruby-value">0644</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_io</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">read_body</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data_chunk</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">data_chunk</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Return open file handle r/w to saved file.</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">path</span>, <span class="ruby-string">"w+"</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:stream_to</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span><span class="ruby-operator">::</span><span class="ruby-constant">PersistedArray</span>)
|
||||
<span class="ruby-identifier">the_accumulator</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:stream_to</span>]
|
||||
<span class="ruby-identifier">buffer</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-identifier">response</span>.<span class="ruby-identifier">read_body</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">data_chunk</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">chunk_ranges</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span>.<span class="ruby-identifier">apportioned_ranges</span>(<span class="ruby-identifier">data_chunk</span>.<span class="ruby-identifier">bytesize</span>,<span class="ruby-value">65536</span>)
|
||||
<span class="ruby-identifier">chunk_ranges</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_range</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)].<span class="ruby-identifier">bytesize</span>) <span class="ruby-operator"><=</span> <span class="ruby-value">65536</span>
|
||||
<span class="ruby-identifier">buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">65536</span>
|
||||
<span class="ruby-identifier">the_accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-identifier">the_accumulator</span>[(<span class="ruby-identifier">the_accumulator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)].<span class="ruby-identifier">unload</span>
|
||||
<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clear</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">the_size</span> = <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span>
|
||||
<span class="ruby-identifier">buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)][(<span class="ruby-value">0</span><span class="ruby-operator">..</span>((<span class="ruby-value">65536</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">the_size</span>) <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">65536</span>
|
||||
<span class="ruby-identifier">the_accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-identifier">the_accumulator</span>[(<span class="ruby-identifier">the_accumulator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)].<span class="ruby-identifier">unload</span>
|
||||
<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clear</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">buffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">data_chunk</span>[(<span class="ruby-identifier">the_range</span>)][((<span class="ruby-value">65536</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">the_size</span>)<span class="ruby-operator">..</span><span class="ruby-value">-1</span>)]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">the_accumulator</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-identifier">the_accumulator</span>[(<span class="ruby-identifier">the_accumulator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)].<span class="ruby-identifier">unload</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:stream_to</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-comment"># Process response</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:raw_response</span>]
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:to_ruby</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">response_hash</span> = {}
|
||||
<span class="ruby-identifier">response_hash</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">to_hash</span>.<span class="ruby-identifier">process</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>, <span class="ruby-identifier">the_key</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_key</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-identifier">entry</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">returns</span>({<span class="ruby-value">:new_selector</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_key</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>), <span class="ruby-value">:result</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">entry</span>)})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response_hash</span>[<span class="ruby-value">:header</span>] = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">header</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">body_text</span> = (<span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">xml?</span>()
|
||||
<span class="ruby-identifier">response_hash</span>[<span class="ruby-value">:body</span>] = <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">from_xml</span>()
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">html?</span>()
|
||||
<span class="ruby-identifier">response_hash</span>[<span class="ruby-value">:body</span>] = <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">from_html</span>()
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to retrieve either XML or HTML as data."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response_hash</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># Default output:</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>]
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-post" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">post</span><span
|
||||
class="method-args">(the_url=nil, form_data=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="post-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5534</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">form_data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPS</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">form_data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide valid form data (in the form of a Hash)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span>)]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">host</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">port</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">server</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-comment"># basic auth</span>
|
||||
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">set_form_data</span>(<span class="ruby-identifier">form_data</span>)
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
||||
<span class="ruby-comment"># Process Redirect</span>
|
||||
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">redirect_request</span>.<span class="ruby-identifier">set_form_data</span>(<span class="ruby-identifier">form_data</span>)
|
||||
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:form_data</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">form_data</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-put" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">put</span><span
|
||||
class="method-args">(the_url=nil, data=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="put-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5433</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">put</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"https"</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPS</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide valid PUT data (in the form of a String: 'parameter = value')"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span>)]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">host</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">port</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">server</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">start</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">pem_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">use_ssl</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">cert</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>)
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">key</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_file</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>])
|
||||
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>,<span class="ruby-identifier">data</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">request_uri</span>,<span class="ruby-identifier">data</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-comment"># basic auth</span>
|
||||
<span class="ruby-identifier">request</span>.<span class="ruby-identifier">basic_auth</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">request</span>)
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:follow_redirects</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator">>=</span> <span class="ruby-value">300</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">response_code</span> <span class="ruby-operator"><</span> <span class="ruby-value">400</span>
|
||||
<span class="ruby-comment"># Process Redirect</span>
|
||||
<span class="ruby-identifier">redirect_count</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">location</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookie</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>, {<span class="ruby-string">'Cookie'</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@cookie</span>})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">redirect_request</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">location</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">redirect_response</span> = <span class="ruby-identifier">server</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">redirect_request</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">redirect_response</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-value">200</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">redirect_count</span> <span class="ruby-operator">></span> <span class="ruby-value">9</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Circular redirect chain suspected (10 or more redirects)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response_code</span> = <span class="ruby-identifier">redirect_response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-identifier">location</span> = <span class="ruby-identifier">redirect_response</span>[<span class="ruby-string">'location'</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Error occured: Code #{response.code}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide a valid HTTP URI"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:form_data</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">data</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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>
|
||||
|
||||
374
doc/GxG/Networking/HttpsClient.html
Normal file
374
doc/GxG/Networking/HttpsClient.html
Normal file
|
|
@ -0,0 +1,374 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::HttpsClient - 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-clear_cache">#clear_cache</a>
|
||||
|
||||
<li ><a href="#method-i-cookies">#cookies</a>
|
||||
|
||||
<li ><a href="#method-i-delete">#delete</a>
|
||||
|
||||
<li ><a href="#method-i-get">#get</a>
|
||||
|
||||
<li ><a href="#method-i-post">#post</a>
|
||||
|
||||
<li ><a href="#method-i-put">#put</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::HttpsClient">
|
||||
<h1 id="class-GxG::Networking::HttpsClient" class="class">
|
||||
class GxG::Networking::HttpsClient
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</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="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5733</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">HttpClient</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-keyword">self</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-clear_cache" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">clear_cache</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="clear_cache-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5742</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear_cache</span>()
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">clear_cache</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-cookies" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">cookies</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="cookies-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5738</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cookies</span>()
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">cookies</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-delete" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">delete</span><span
|
||||
class="method-args">(the_url=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="delete-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5755</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-get" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get</span><span
|
||||
class="method-args">(the_url=nil, options={:follow_redirects => true, :use_ssl => true})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="get-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5746</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={<span class="ruby-value">:follow_redirects</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:use_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-post" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">post</span><span
|
||||
class="method-args">(the_url=nil, form_data=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="post-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5752</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">form_data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">form_data</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-put" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">put</span><span
|
||||
class="method-args">(the_url=nil, data=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="put-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5749</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">put</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">put</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">data</span>,<span class="ruby-identifier">options</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>
|
||||
|
||||
378
doc/GxG/Networking/HttpsClientWithPem.html
Normal file
378
doc/GxG/Networking/HttpsClientWithPem.html
Normal file
|
|
@ -0,0 +1,378 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::HttpsClientWithPem - 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-clear_cache">#clear_cache</a>
|
||||
|
||||
<li ><a href="#method-i-cookies">#cookies</a>
|
||||
|
||||
<li ><a href="#method-i-delete">#delete</a>
|
||||
|
||||
<li ><a href="#method-i-get">#get</a>
|
||||
|
||||
<li ><a href="#method-i-post">#post</a>
|
||||
|
||||
<li ><a href="#method-i-put">#put</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::HttpsClientWithPem">
|
||||
<h1 id="class-GxG::Networking::HttpsClientWithPem" class="class">
|
||||
class GxG::Networking::HttpsClientWithPem
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(pem_file_path=nil)</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/gxg/net_clients.rb, line 5761</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">pem_file_path</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">pem_file_path</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a path to your PEM file (as a String)."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@pem_path</span> = <span class="ruby-identifier">pem_file_path</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">HttpClient</span>.<span class="ruby-identifier">new</span>()
|
||||
<span class="ruby-keyword">self</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-clear_cache" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">clear_cache</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="clear_cache-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5774</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear_cache</span>()
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">clear_cache</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-cookies" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">cookies</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="cookies-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5770</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cookies</span>()
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">cookies</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-delete" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">delete</span><span
|
||||
class="method-args">(the_url=nil, options={:follow_symlinks => true})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="delete-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5787</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={<span class="ruby-value">:follow_symlinks</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:use_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:pem_file</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@pem_path</span>}))
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-get" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get</span><span
|
||||
class="method-args">(the_url=nil, options={:follow_symlinks => true})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="get-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5778</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={<span class="ruby-value">:follow_symlinks</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:use_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:pem_file</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@pem_path</span>}))
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-post" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">post</span><span
|
||||
class="method-args">(the_url=nil, form_data=nil, options={:follow_symlinks => true})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="post-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5784</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">form_data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={<span class="ruby-value">:follow_symlinks</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">form_data</span>,<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:use_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:pem_file</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@pem_path</span>}))
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-put" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">put</span><span
|
||||
class="method-args">(the_url=nil, data=nil, options={:follow_symlinks => true})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="put-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 5781</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">put</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={<span class="ruby-value">:follow_symlinks</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">put</span>(<span class="ruby-identifier">the_url</span>,<span class="ruby-identifier">data</span>,<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:use_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>, <span class="ruby-value">:pem_file</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@pem_path</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>
|
||||
|
||||
1965
doc/GxG/Networking/ImapClient.html
Normal file
1965
doc/GxG/Networking/ImapClient.html
Normal file
File diff suppressed because it is too large
Load diff
448
doc/GxG/Networking/Pop3Client.html
Normal file
448
doc/GxG/Networking/Pop3Client.html
Normal file
|
|
@ -0,0 +1,448 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::Pop3Client - 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-login">#login</a>
|
||||
|
||||
<li ><a href="#method-i-logout">#logout</a>
|
||||
|
||||
<li ><a href="#method-i-message_count">#message_count</a>
|
||||
|
||||
<li ><a href="#method-i-retrieve_messages">#retrieve_messages</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::Pop3Client">
|
||||
<h1 id="class-GxG::Networking::Pop3Client" class="class">
|
||||
class GxG::Networking::Pop3Client
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>POP3 Classes:</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">(host=nil,port=nil,options={})</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/gxg/net_clients.rb, line 1626</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">host</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">port</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">port</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">port</span>
|
||||
<span class="ruby-identifier">port</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@user</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@password</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@host</span> = <span class="ruby-identifier">host</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@host</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a HOST, like this: <host>,(<port>),(<options>)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@port</span> = (<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">995</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@port</span> = (<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">110</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">POP3</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@host</span>, <span class="ruby-ivar">@port</span>, (<span class="ruby-identifier">options</span>[<span class="ruby-value">:use_apop</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">false</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:ignore_ssl_errors</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">enable_ssl</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_NONE</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">enable_ssl</span>(<span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">self</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-login" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">login</span><span
|
||||
class="method-args">(user_id=nil,password=nil,options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="login-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1655</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">user_id</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">password</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-ivar">@user</span> = <span class="ruby-identifier">user_id</span>
|
||||
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@password</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a PASSWORD, like this: <user_id>,<password>,(<options>)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">start</span>(<span class="ruby-ivar">@user</span>, <span class="ruby-ivar">@password</span>)
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-logout" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">logout</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="logout-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1670</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">finish</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-message_count" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">message_count</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="message_count-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1678</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">message_count</span>()
|
||||
<span class="ruby-comment"># Return the number of emails on the server.</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">n_mails</span>()
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-retrieve_messages" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">retrieve_messages</span><span
|
||||
class="method-args">(options={:read_only=>false},&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="retrieve_messages-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1687</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">retrieve_messages</span>(<span class="ruby-identifier">options</span>={<span class="ruby-value">:read_only</span><span class="ruby-operator">=></span><span class="ruby-keyword">false</span>},<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = []
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">started?</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">active?</span>
|
||||
<span class="ruby-identifier">parse_message</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_raw_message</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">header</span> = {}
|
||||
<span class="ruby-identifier">body</span> = []
|
||||
<span class="ruby-identifier">attachments</span> = []
|
||||
<span class="ruby-identifier">parser</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Mail</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_raw_message</span>.<span class="ruby-identifier">pop</span>)
|
||||
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">header_fields</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">field</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">the_key</span> = <span class="ruby-identifier">field</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-identifier">the_data</span> = <span class="ruby-identifier">field</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)
|
||||
<span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">" "</span>,<span class="ruby-string">""</span>)
|
||||
<span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">" "</span>,<span class="ruby-string">""</span>)
|
||||
<span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">" "</span>,<span class="ruby-string">""</span>)
|
||||
<span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">"\r\n"</span>,<span class="ruby-string">""</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">header</span>[(<span class="ruby-identifier">the_key</span>)]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">header</span>[(<span class="ruby-identifier">the_key</span>)].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">header</span>[(<span class="ruby-identifier">the_key</span>)] = [(<span class="ruby-identifier">header</span>[(<span class="ruby-identifier">the_key</span>)])]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">header</span>[(<span class="ruby-identifier">the_key</span>)] <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_data</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">header</span>[(<span class="ruby-identifier">the_key</span>)] = <span class="ruby-identifier">the_data</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">multipart?</span>
|
||||
<span class="ruby-identifier">link_db</span> = []
|
||||
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:preamble</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">preamble</span>}
|
||||
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">parts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">multipart?</span>
|
||||
<span class="ruby-identifier">link_db</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">part</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">attachment?</span>
|
||||
<span class="ruby-identifier">attachments</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">mime_type</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">content_type_parameters</span>}, <span class="ruby-value">:filename</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">filename</span>, <span class="ruby-value">:path</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">part</span>.<span class="ruby-identifier">decoded</span>)}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">mime_type</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">content_type_parameters</span>}, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">while</span> <span class="ruby-identifier">link_db</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-identifier">part</span> = <span class="ruby-identifier">link_db</span>.<span class="ruby-identifier">shift</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">multipart?</span>
|
||||
<span class="ruby-identifier">part</span>.<span class="ruby-identifier">parts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_sub_part</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">link_db</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_sub_part</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">attachment?</span>
|
||||
<span class="ruby-identifier">attachments</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">mime_type</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">content_type_parameters</span>}, <span class="ruby-value">:filename</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">filename</span>, <span class="ruby-value">:path</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">part</span>.<span class="ruby-identifier">decoded</span>)}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">mime_type</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">content_type_parameters</span>}, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:epilogue</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">epilogue</span>}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:preamble</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">preamble</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)}
|
||||
<span class="ruby-identifier">mime_type</span> = <span class="ruby-string">"text/plain"</span>
|
||||
<span class="ruby-identifier">parameters</span> = {<span class="ruby-string">"charset"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"UTF-8"</span>}
|
||||
<span class="ruby-identifier">body_text</span> = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">xml?</span>
|
||||
<span class="ruby-identifier">mime_type</span> = <span class="ruby-string">"text/xml"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">body_text</span>.<span class="ruby-identifier">html?</span>
|
||||
<span class="ruby-identifier">mime_type</span> = <span class="ruby-string">"text/html"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mime_type</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">parameters</span>}, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">body_text</span>}
|
||||
<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> {<span class="ruby-value">:epilogue</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">epilogueto_s</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">gxg_message</span> = <span class="ruby-identifier">new_message</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>] = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">from</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:id</span>] = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">message_id</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:to</span>] = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">to</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:cc</span>] = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">cc</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:bcc</span>] = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">bcc</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:subject</span>] = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">subject</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:date</span>] = <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">date</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:header</span>] = <span class="ruby-identifier">header</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>] = <span class="ruby-identifier">body</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:attachments</span>] = <span class="ruby-identifier">attachments</span>
|
||||
<span class="ruby-identifier">gxg_message</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">each_mail</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">raw_message</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">parse_message</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">raw_message</span>))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">parse_message</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">raw_message</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:read_only</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">raw_message</span>.<span class="ruby-identifier">delete</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">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></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>
|
||||
|
||||
638
doc/GxG/Networking/RestClient.html
Normal file
638
doc/GxG/Networking/RestClient.html
Normal file
|
|
@ -0,0 +1,638 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::RestClient - 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-clear_system_proxy">::clear_system_proxy</a>
|
||||
|
||||
<li ><a href="#method-c-set_system_proxy">::set_system_proxy</a>
|
||||
|
||||
<li ><a href="#method-i-clear_cache">#clear_cache</a>
|
||||
|
||||
<li ><a href="#method-i-delete">#delete</a>
|
||||
|
||||
<li ><a href="#method-i-get">#get</a>
|
||||
|
||||
<li ><a href="#method-i-intitialize">#intitialize</a>
|
||||
|
||||
<li ><a href="#method-i-post">#post</a>
|
||||
|
||||
<li ><a href="#method-i-put">#put</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::RestClient">
|
||||
<h1 id="class-GxG::Networking::RestClient" class="class">
|
||||
class GxG::Networking::RestClient
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>REST Classes:</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-clear_system_proxy" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">clear_system_proxy</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="clear_system_proxy-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1807</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">clear_system_proxy</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">proxy</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-set_system_proxy" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">set_system_proxy</span><span
|
||||
class="method-args">(the_url=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="set_system_proxy-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1793</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">set_system_proxy</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid proxy URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">proxy</span> = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</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 id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-clear_cache" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">clear_cache</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="clear_cache-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1828</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">clear_cache</span>()
|
||||
<span class="ruby-ivar">@cookies</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-delete" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">delete</span><span
|
||||
class="method-args">(the_url=nil, options={}, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="delete-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2019</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">header_options</span> = (<span class="ruby-identifier">options</span>[<span class="ruby-value">:header_options</span>] <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">merge</span>({<span class="ruby-value">:accept</span> <span class="ruby-operator">=></span> <span class="ruby-value">:json</span>})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>]
|
||||
<span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>] = <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>]
|
||||
<span class="ruby-identifier">pem_data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">header_options</span> = <span class="ruby-identifier">header_options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:ssl_client_cert</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>), <span class="ruby-value">:ssl_client_key</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>]), <span class="ruby-value">:verify_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">header_options</span>[<span class="ruby-value">:proxy</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">header_options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:raw_response</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-get" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">get</span><span
|
||||
class="method-args">(the_url=nil, options={}, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="get-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1833</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">header_options</span> = (<span class="ruby-identifier">options</span>[<span class="ruby-value">:header_options</span>] <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">merge</span>({<span class="ruby-value">:accept</span> <span class="ruby-operator">=></span> <span class="ruby-value">:json</span>})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>]
|
||||
<span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>] = <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>]
|
||||
<span class="ruby-identifier">pem_data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">header_options</span> = <span class="ruby-identifier">header_options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:ssl_client_cert</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>), <span class="ruby-value">:ssl_client_key</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>]), <span class="ruby-value">:verify_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">header_options</span>[<span class="ruby-value">:proxy</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">HttpClient</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">the_url</span>, {<span class="ruby-value">:save_as</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:save_as</span>], <span class="ruby-value">:proxy</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>]})
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:parameters</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">header_options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:params</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:parameters</span>]}), <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">header_options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">cookies</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">cookies</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-ivar">@cookies</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">cookies</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:raw_response</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">the_data</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">base64?</span>
|
||||
<span class="ruby-identifier">the_data</span> = <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">decode64</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">json?</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">from_json</span>()
|
||||
<span class="ruby-comment"># post-process value strings for DateTime, etc patterns and parse to ruby instances.</span>
|
||||
<span class="ruby-comment"># post-process - symbolize keys</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">xml?</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:xml_simple</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">from_xml_simple</span>()
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">from_xml</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">html?</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">the_data</span>.<span class="ruby-identifier">from_html</span>()
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">the_data</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">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-intitialize" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">intitialize</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="intitialize-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1818</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">intitialize</span>()
|
||||
<span class="ruby-comment"># REST Servers to test with:</span>
|
||||
<span class="ruby-comment"># http://services.groupkt.com/country/get/all</span>
|
||||
<span class="ruby-comment"># http://services.groupkt.com/state/get/{countryCode}/all</span>
|
||||
<span class="ruby-comment"># https://httpbin.org/get</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-ivar">@cookies</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">self</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-post" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">post</span><span
|
||||
class="method-args">(the_url=nil, form_data=nil, options={}, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="post-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1968</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">post</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">form_data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">form_data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide valid form data (in the form of a Hash)."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">header_options</span> = (<span class="ruby-identifier">options</span>[<span class="ruby-value">:header_options</span>] <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">merge</span>({<span class="ruby-value">:accept</span> <span class="ruby-operator">=></span> <span class="ruby-value">:json</span>})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>]
|
||||
<span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>] = <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>]
|
||||
<span class="ruby-identifier">pem_data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">header_options</span> = <span class="ruby-identifier">header_options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:ssl_client_cert</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>), <span class="ruby-value">:ssl_client_key</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>]), <span class="ruby-value">:verify_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">header_options</span>[<span class="ruby-value">:proxy</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:upload_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">form_data</span>[<span class="ruby-value">:file</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:upload_file</span>], <span class="ruby-string">"rb"</span>)
|
||||
<span class="ruby-identifier">form_data</span>[<span class="ruby-value">:multipart</span>] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">form_data</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">valid_path?</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">the_value</span>)
|
||||
<span class="ruby-identifier">form_data</span>[(<span class="ruby-identifier">the_key</span>)] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_value</span>, <span class="ruby-string">"rb"</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">end</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">form_data</span>, <span class="ruby-identifier">header_options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:raw_response</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-put" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">put</span><span
|
||||
class="method-args">(the_url=nil, data=nil, options={}, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="put-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1906</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">put</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">data</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"You MUST provide data to PUT to the server (in the form of a Hash)."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">header_options</span> = (<span class="ruby-identifier">options</span>[<span class="ruby-value">:header_options</span>] <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">merge</span>({<span class="ruby-value">:accept</span> <span class="ruby-operator">=></span> <span class="ruby-value">:json</span>})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>]
|
||||
<span class="ruby-identifier">header_options</span>[<span class="ruby-value">:cookies</span>] = <span class="ruby-ivar">@cookies</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>]
|
||||
<span class="ruby-identifier">pem_data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_file</span>])
|
||||
<span class="ruby-identifier">header_options</span> = <span class="ruby-identifier">header_options</span>.<span class="ruby-identifier">merge</span>({<span class="ruby-value">:ssl_client_cert</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">X509</span><span class="ruby-operator">::</span><span class="ruby-constant">Certificate</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>), <span class="ruby-value">:ssl_client_key</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">PKey</span><span class="ruby-operator">::</span><span class="ruby-constant">RSA</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">pem_data</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value">:pem_password</span>]), <span class="ruby-value">:verify_ssl</span> <span class="ruby-operator">=></span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">header_options</span>[<span class="ruby-value">:proxy</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:to_json</span>]
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_json</span>()
|
||||
<span class="ruby-identifier">header_options</span>[<span class="ruby-value">:content_type</span>] = <span class="ruby-value">:json</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:upload_file</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:upload_file</span>].<span class="ruby-identifier">valid_path?</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:upload_file</span>])
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"File does not exist: #{options[:upload_file].inspect}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">data</span>[(<span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>)] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:upload_file</span>], <span class="ruby-string">"rb"</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid path String if you use the :upload_file option."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">valid_path?</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">the_value</span>)
|
||||
<span class="ruby-identifier">data</span>[(<span class="ruby-identifier">the_key</span>)] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_value</span>, <span class="ruby-string">"rb"</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">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-operator">::</span><span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">put</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">header_options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:raw_response</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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>
|
||||
|
||||
1145
doc/GxG/Networking/SftpClient.html
Normal file
1145
doc/GxG/Networking/SftpClient.html
Normal file
File diff suppressed because it is too large
Load diff
625
doc/GxG/Networking/SmtpClient.html
Normal file
625
doc/GxG/Networking/SmtpClient.html
Normal file
|
|
@ -0,0 +1,625 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::SmtpClient - 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-attachment_template">#attachment_template</a>
|
||||
|
||||
<li ><a href="#method-i-host">#host</a>
|
||||
|
||||
<li ><a href="#method-i-login">#login</a>
|
||||
|
||||
<li ><a href="#method-i-logout">#logout</a>
|
||||
|
||||
<li ><a href="#method-i-message_template">#message_template</a>
|
||||
|
||||
<li ><a href="#method-i-port">#port</a>
|
||||
|
||||
<li ><a href="#method-i-send_message">#send_message</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::SmtpClient">
|
||||
<h1 id="class-GxG::Networking::SmtpClient" class="class">
|
||||
class GxG::Networking::SmtpClient
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>SMTP Classes:</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">(host=nil,port=nil,options={})</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/gxg/net_clients.rb, line 1375</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">host</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">port</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">port</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">port</span>
|
||||
<span class="ruby-identifier">port</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@user</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@password</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@host</span> = <span class="ruby-identifier">host</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@host</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a HOST, like this: <host>,(<port>),(<options>)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@port</span> = (<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">465</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_method</span>]
|
||||
<span class="ruby-comment"># Valid: [:TLSv1, :TLSv1_server, :TLSv1_client, :TLSv1_1, :TLSv1_1_server, :TLSv1_1_client, :TLSv1_2, :TLSv1_2_server, :TLSv1_2_client, :SSLv23, :SSLv23_server, :SSLv23_client]</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLContext</span><span class="ruby-operator">::</span><span class="ruby-constant">METHODS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_method</span>])
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Encryption method #{options[:ssl_method].inspect} is not valid. Choose one of these: #{OpenSSL::SSL::SSLContext::METHODS.inspect}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">openssl_context</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSLContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:ssl_method</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">openssl_context</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SMTP</span>.<span class="ruby-identifier">default_ssl_context</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:ignore_ssl_errors</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">openssl_context</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_NONE</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">openssl_context</span>.<span class="ruby-identifier">verify_mode</span> = <span class="ruby-constant">OpenSSL</span><span class="ruby-operator">::</span><span class="ruby-constant">SSL</span><span class="ruby-operator">::</span><span class="ruby-constant">VERIFY_PEER</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@port</span> = (<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">25</span>)
|
||||
<span class="ruby-identifier">openssl_context</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SMTP</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@host</span>, <span class="ruby-ivar">@port</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">openssl_context</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">enable_ssl</span>(<span class="ruby-identifier">openssl_context</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">self</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-attachment_template" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">attachment_template</span><span
|
||||
class="method-args">(the_path="", content_parameters={"name" => ""})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="attachment_template-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1472</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attachment_template</span>(<span class="ruby-identifier">the_path</span>=<span class="ruby-string">""</span>, <span class="ruby-identifier">content_parameters</span>={<span class="ruby-string">"name"</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">valid_path?</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid file system path to the file."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">content_parameters</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide content_parameters as a Hash."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">content_parameters</span>[<span class="ruby-string">"name"</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">content_parameters</span>[<span class="ruby-string">"name"</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">the_path</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">discovered_mime</span> = <span class="ruby-operator">::</span><span class="ruby-constant">MimeMagic</span>.<span class="ruby-identifier">by_magic</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">the_path</span>,<span class="ruby-string">"rb"</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">discovered_mime</span>
|
||||
<span class="ruby-identifier">discovered_mime</span> = <span class="ruby-identifier">discovered_mime</span>.<span class="ruby-identifier">type</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">discovered_mime</span> = <span class="ruby-string">"application/octet-stream"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">discovered_mime</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}, <span class="ruby-value">:filename</span> <span class="ruby-operator">=></span> (<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">the_path</span>)), <span class="ruby-value">:path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_path</span>, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>.<span class="ruby-identifier">new</span>}
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_path</span>, <span class="ruby-value">:content_parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-host" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">host</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="host-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1415</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">host</span>()
|
||||
<span class="ruby-ivar">@host</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-login" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">login</span><span
|
||||
class="method-args">(user_id=nil,password=nil,authentication_method=:plain)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="login-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1423</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">user_id</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">password</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">authentication_method</span>=<span class="ruby-value">:plain</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-ivar">@user</span> = <span class="ruby-identifier">user_id</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@user</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a USER id, like this: <user_id>,<password/oauth-token>,(<options>)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@password</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a PASSWORD/OAUTH-TOKEN, like this: <user_id>,<password/oauth-token>,(<options>)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">started?</span>
|
||||
<span class="ruby-keyword">unless</span> [<span class="ruby-value">:plain</span>, <span class="ruby-value">:login</span>, <span class="ruby-value">:cram_md5</span>, <span class="ruby-value">:oauth2</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">authentication_method</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"Authentication method #{authentication_method.inspect} is invalid. Choose one of these: [:plain, :login, :cram_md5, :oauth2]"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Internal cosmetics for interface consistency.</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">authentication_method</span> <span class="ruby-operator">==</span> <span class="ruby-value">:oauth2</span>
|
||||
<span class="ruby-identifier">authentication_method</span> = <span class="ruby-value">:xoauth2</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">start</span>(<span class="ruby-ivar">@host</span>, <span class="ruby-ivar">@user</span>, <span class="ruby-ivar">@password</span>, <span class="ruby-identifier">authentication_method</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-comment"># Internal cosmetics for interface consistency.</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">authentication_method</span> <span class="ruby-operator">==</span> <span class="ruby-value">:xoauth2</span>
|
||||
<span class="ruby-identifier">authentication_method</span> = <span class="ruby-value">:oauth2</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:user</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">user_id</span>, <span class="ruby-value">:authentication</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">authentication_method</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>
|
||||
|
||||
|
||||
<div id="method-i-logout" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">logout</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="logout-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1457</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">finish</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</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>
|
||||
|
||||
|
||||
<div id="method-i-message_template" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">message_template</span><span
|
||||
class="method-args">(mime_type="text/plain", content_parameters={"charset"=>"UTF-8"})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="message_template-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1497</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">message_template</span>(<span class="ruby-identifier">mime_type</span>=<span class="ruby-string">"text/plain"</span>, <span class="ruby-identifier">content_parameters</span>={<span class="ruby-string">"charset"</span><span class="ruby-operator">=></span><span class="ruby-string">"UTF-8"</span>})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> [<span class="ruby-string">'text/plain'</span>, <span class="ruby-string">'text/html'</span>, <span class="ruby-string">'text/xhtml'</span>, <span class="ruby-string">'text/xml'</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">mime_type</span>.<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"Content Type specified was invalid. Choose one of these: ['text/plain', 'text/html', 'text/xhtml', 'text/xml']"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">content_parameters</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide content_parameters as a Hash."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">gxg_message</span> = <span class="ruby-identifier">new_message</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>] = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:id</span>] = <span class="ruby-node">"<#{gxg_message[:id].to_s}@#{::Socket.gethostname}.mail>"</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:to</span>] = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:cc</span>] = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:bcc</span>] = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:subject</span>] = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:date</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">now</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:header</span>] = {}
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>] = [{<span class="ruby-value">:prologue</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>},{<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mime_type</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}, <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>},{<span class="ruby-value">:epilogue</span> <span class="ruby-operator">=></span> <span class="ruby-string">""</span>}]
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:attachments</span>] = []
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">gxg_message</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:content_type</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mime_type</span>, <span class="ruby-value">:content_parameters</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">content_parameters</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-port" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">port</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="port-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1419</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">port</span>()
|
||||
<span class="ruby-ivar">@port</span>.<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-send_message" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">send_message</span><span
|
||||
class="method-args">(gxg_message=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="send_message-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 1524</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_message</span>(<span class="ruby-identifier">gxg_message</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">started?</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"SMTP session not started yet."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">gxg_message</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Events</span><span class="ruby-operator">::</span><span class="ruby-constant">Message</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid message object of class ::GxG::Events::Message. Suggested: <SmtpClient>.message_template(<Mime-Type-String>)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Build suitable mail message</span>
|
||||
<span class="ruby-identifier">message</span> = <span class="ruby-constant">Mail</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-identifier">the_fields</span> = []
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:header</span>].<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">the_value</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_field_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">the_fields</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{the_key.to_s}: #{the_field_value.to_s}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">the_fields</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{the_key.to_s}: #{the_value.to_s}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">header</span> = <span class="ruby-identifier">the_fields</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\r\n"</span>)
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">from</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>]
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">reply_to</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"@"</span>)
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">message_id</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">message_id</span> = <span class="ruby-node">"<#{gxg_message[:id].to_s}@#{::Socket.gethostname}.mail>"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">to</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:to</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:cc</span>]
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">cc</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:cc</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:bcc</span>]
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">bcc</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:bcc</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">subject</span> = <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:subject</span>]
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">date</span> = (<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:date</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">DateTime</span>.<span class="ruby-identifier">now</span>.<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:attachments</span>].<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">multipart</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">part_count</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:prologue</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:epilogue</span>]
|
||||
<span class="ruby-identifier">part_count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part_count</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">multipart</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">multipart</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">multipart</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:prologue</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:epilogue</span>]
|
||||
<span class="ruby-identifier">type_info</span> = <span class="ruby-node">"Content-Type: #{part[:content_type][:type]}"</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:content_type</span>][<span class="ruby-value">:parameters</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">part</span>[<span class="ruby-value">:content_type</span>][<span class="ruby-value">:parameters</span>].<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">type_info</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"; '#{the_key.to_s}': '#{the_value.to_s}'"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">new_part</span> = <span class="ruby-constant">Mail</span><span class="ruby-operator">::</span><span class="ruby-constant">Part</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">type_info</span>)
|
||||
<span class="ruby-identifier">new_part</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">part</span>[<span class="ruby-value">:content</span>]
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">add_part</span>(<span class="ruby-identifier">new_part</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Add file attachments:</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:attachments</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attachment</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">attachment</span>[<span class="ruby-value">:content</span>].<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">file_size</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">size</span>(<span class="ruby-identifier">attachment</span>[<span class="ruby-value">:path</span>])
|
||||
<span class="ruby-identifier">file_handle</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">attachment</span>[<span class="ruby-value">:path</span>],<span class="ruby-string">"rb"</span>)
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">apportioned_ranges</span>(<span class="ruby-identifier">file_size</span>,<span class="ruby-value">65536</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_range</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">file_handle</span>.<span class="ruby-identifier">seek</span>(<span class="ruby-identifier">the_range</span>.<span class="ruby-identifier">first</span>)
|
||||
<span class="ruby-identifier">attachment</span>[<span class="ruby-value">:content</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">file_handle</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">the_range</span>.<span class="ruby-identifier">size</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">file_handle</span>.<span class="ruby-identifier">close</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">add_file</span>({<span class="ruby-value">:filename</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">attachment</span>[<span class="ruby-value">:filename</span>], <span class="ruby-value">:content</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">attachment</span>[<span class="ruby-value">:content</span>].<span class="ruby-identifier">to_s</span>})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:body</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:prologue</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">part</span>[<span class="ruby-value">:epilogue</span>]
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">part</span>[<span class="ruby-value">:content</span>]
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Send it</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-identifier">message</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">gxg_message</span>[<span class="ruby-value">:sender</span>], <span class="ruby-identifier">message</span>.<span class="ruby-identifier">destinations</span>)
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:message</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">gxg_message</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>
|
||||
|
||||
415
doc/GxG/Networking/SoapClient.html
Normal file
415
doc/GxG/Networking/SoapClient.html
Normal file
|
|
@ -0,0 +1,415 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::SoapClient - 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-callmethod">#callmethod</a>
|
||||
|
||||
<li ><a href="#method-i-closed-3F">#closed?</a>
|
||||
|
||||
<li ><a href="#method-i-interface">#interface</a>
|
||||
|
||||
<li ><a href="#method-i-login">#login</a>
|
||||
|
||||
<li ><a href="#method-i-logout">#logout</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::SoapClient">
|
||||
<h1 id="class-GxG::Networking::SoapClient" class="class">
|
||||
class GxG::Networking::SoapClient
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Standard:</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2236</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">self</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-callmethod" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">callmethod</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="callmethod-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2265</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">callmethod</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">the_method</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">arguments</span> = {}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">the_method</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a Hash or Array to specify parameters for this method."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">arguments</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid SOAP method."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-identifier">response_tag</span> = (<span class="ruby-identifier">the_method</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^.+:/</span>, <span class="ruby-string">""</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"Response"</span>)
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">invoke</span>(<span class="ruby-identifier">the_method</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">message</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_key</span>, <span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">the_key</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">the_value</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_value</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">message</span>.<span class="ruby-identifier">add</span>(<span class="ruby-string">"literal"</span>, <span class="ruby-identifier">the_value</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Oga</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse_xml</span>(<span class="ruby-identifier">response</span>.<span class="ruby-identifier">to_xml</span>).<span class="ruby-identifier">css</span>(<span class="ruby-identifier">response_tag</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>
|
||||
<span class="ruby-identifier">found_numbers</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">text</span>.<span class="ruby-identifier">numeric_values</span>
|
||||
<span class="ruby-identifier">found_value</span> = []
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">found_numbers</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">found_numbers</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_subarray</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_subarray</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_subarray</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">the_key</span> = <span class="ruby-identifier">the_subarray</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">keys</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-identifier">found_value</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_subarray</span>[<span class="ruby-value">0</span>][(<span class="ruby-identifier">the_key</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-identifier">result</span> = {}
|
||||
<span class="ruby-identifier">result</span>[(<span class="ruby-identifier">response_tag</span>.<span class="ruby-identifier">to_sym</span>)] = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">text</span>
|
||||
<span class="ruby-comment"># if found_value.size > 0</span>
|
||||
<span class="ruby-comment"># if found_value.size == 1</span>
|
||||
<span class="ruby-comment"># result[(response_tag.to_sym)] = found_value[0]</span>
|
||||
<span class="ruby-comment"># else</span>
|
||||
<span class="ruby-comment"># result[(response_tag.to_sym)] = found_value</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># else</span>
|
||||
<span class="ruby-comment"># result[(response_tag.to_sym)] = data.text</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Failed to interpret response data. Data: #{data.inspect}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:method</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_method</span>, <span class="ruby-value">:arguments</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">arguments</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-closed-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">closed?</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="closed-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2257</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-interface" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">interface</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="interface-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2331</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">interface</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">interface</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-login" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">login</span><span
|
||||
class="method-args">(the_url=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="login-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2241</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">SoapDriver</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">the_url</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-logout" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">logout</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="logout-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2252</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
460
doc/GxG/Networking/SoapDriver.html
Normal file
460
doc/GxG/Networking/SoapDriver.html
Normal file
|
|
@ -0,0 +1,460 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::SoapDriver - 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">Handsoap::Service
|
||||
|
||||
</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-i-interface">#interface</a>
|
||||
|
||||
<li ><a href="#method-i-on_before_dispatch">#on_before_dispatch</a>
|
||||
|
||||
<li ><a href="#method-i-on_create_document">#on_create_document</a>
|
||||
|
||||
<li ><a href="#method-i-on_response_document">#on_response_document</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::SoapDriver">
|
||||
<h1 id="class-GxG::Networking::SoapDriver" class="class">
|
||||
class GxG::Networking::SoapDriver
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>SOAP Classes:</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">(the_url=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Example sites to test with: <a href="http://www.restfulwebservices.net/rest/WeatherForecastService.svc?wsdl">www.restfulwebservices.net/rest/WeatherForecastService.svc?wsdl</a> <a href="http://www.restfulwebservices.net/wcf/WeatherForecastService.svc?wsdl">www.restfulwebservices.net/wcf/WeatherForecastService.svc?wsdl</a> <a href="https://graphical.weather.gov/xml/DWMLgen/wsdl/ndfdXML.wsdl">graphical.weather.gov/xml/DWMLgen/wsdl/ndfdXML.wsdl</a> <a href="http://www.webservicex.com/CurrencyConvertor.asmx?wsdl">www.webservicex.com/CurrencyConvertor.asmx?wsdl</a></p>
|
||||
|
||||
|
||||
<div class="method-calls-super">
|
||||
Calls superclass method
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2062</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">super</span>()
|
||||
<span class="ruby-ivar">@user</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@password</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@interface</span> = []
|
||||
<span class="ruby-ivar">@tns_url</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">Handsoap</span><span class="ruby-operator">::</span><span class="ruby-identifier">http_driver</span> = <span class="ruby-value">:net_http</span>
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">Handsoap</span><span class="ruby-operator">::</span><span class="ruby-identifier">xml_query_driver</span> = <span class="ruby-value">:rexml</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">query</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"wsdl"</span>) <span class="ruby-operator">||</span> (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"wsdl"</span>))
|
||||
<span class="ruby-identifier">point</span> = (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">"://"</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-identifier">point</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-ivar">@user</span> = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">point</span> <span class="ruby-operator"><<</span> (<span class="ruby-string">":"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>)
|
||||
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-identifier">point</span> <span class="ruby-operator"><<</span> (<span class="ruby-string">"@"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">point</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">path</span>
|
||||
<span class="ruby-identifier">point</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">path</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># Process WSDL, determine actual version number from that.</span>
|
||||
<span class="ruby-identifier">http_tool</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">HttpClient</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-identifier">response</span> = <span class="ruby-identifier">http_tool</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">the_url</span>, {<span class="ruby-value">:raw_response</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">response</span>
|
||||
<span class="ruby-identifier">wsdl_data</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">transcode</span>({<span class="ruby-value">:replace</span> <span class="ruby-operator">=></span> <span class="ruby-string">"."</span>},<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">wsdl_data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"http://schemas.xmlsoap.org/soap/envelope/"</span>)
|
||||
<span class="ruby-identifier">wsdl_version</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">wsdl_version</span> = <span class="ruby-value">2</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">SoapDriver</span><span class="ruby-operator">::</span><span class="ruby-identifier">endpoint</span>({<span class="ruby-value">:uri</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">point</span>), <span class="ruby-value">:version</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">wsdl_version</span>)})
|
||||
<span class="ruby-comment"># Build Interface Data:</span>
|
||||
<span class="ruby-identifier">document</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Oga</span>.<span class="ruby-identifier">parse_xml</span>(<span class="ruby-identifier">wsdl_data</span>)
|
||||
<span class="ruby-identifier">nodes</span> = <span class="ruby-identifier">document</span>.<span class="ruby-identifier">css</span>(<span class="ruby-string">"definitions"</span>)
|
||||
<span class="ruby-identifier">nodes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Oga</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>)
|
||||
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attribute</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-string">"tns"</span>, <span class="ruby-string">"targetNamespace"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">attribute</span>.<span class="ruby-identifier">name</span>)
|
||||
<span class="ruby-ivar">@tns_url</span> = <span class="ruby-identifier">attribute</span>.<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@tns_url</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@tns_url</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to load namespace (required)."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">nodes</span> = <span class="ruby-identifier">document</span>.<span class="ruby-identifier">css</span>(<span class="ruby-string">"portType"</span>)
|
||||
<span class="ruby-identifier">base_names</span> = []
|
||||
<span class="ruby-identifier">nodes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Oga</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>)
|
||||
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_operation</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_operation</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Oga</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>)
|
||||
<span class="ruby-identifier">basename</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">the_operation</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">attribute</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">attribute</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"name"</span>
|
||||
<span class="ruby-identifier">basename</span> = <span class="ruby-identifier">attribute</span>.<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">basename</span>
|
||||
<span class="ruby-identifier">record</span> = {<span class="ruby-value">:base</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">basename</span>), <span class="ruby-value">:message</span> <span class="ruby-operator">=></span> ((<span class="ruby-string">"tns:"</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">basename</span>).<span class="ruby-identifier">to_sym</span>), <span class="ruby-value">:input</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:output</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>}
|
||||
<span class="ruby-identifier">the_operation</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_io</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Oga</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>)
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-string">"input"</span>, <span class="ruby-string">"output"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">name</span>)
|
||||
<span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_message</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_message</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"message"</span>
|
||||
<span class="ruby-identifier">record</span>[(<span class="ruby-identifier">the_io</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>)] = <span class="ruby-identifier">the_message</span>.<span class="ruby-identifier">value</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">if</span> <span class="ruby-identifier">record</span>[<span class="ruby-value">:input</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">record</span>[<span class="ruby-value">:output</span>]
|
||||
<span class="ruby-identifier">base_names</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">record</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-identifier">messages</span> = <span class="ruby-identifier">document</span>.<span class="ruby-identifier">css</span>(<span class="ruby-string">"message"</span>)
|
||||
<span class="ruby-identifier">base_names</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_method</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">record</span> = {<span class="ruby-value">:method</span> <span class="ruby-operator">=></span> (<span class="ruby-identifier">the_method</span>[<span class="ruby-value">:message</span>]), <span class="ruby-value">:input</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:output</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>}
|
||||
<span class="ruby-identifier">messages</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_message</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_message</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Oga</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>)
|
||||
<span class="ruby-identifier">the_message</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_attribute</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">direction_key</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_method</span>[<span class="ruby-value">:input</span>].<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^.+:/</span>, <span class="ruby-string">""</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">the_attribute</span>.<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-identifier">direction_key</span> = <span class="ruby-value">:input</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_method</span>[<span class="ruby-value">:output</span>].<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/^.+:/</span>, <span class="ruby-string">""</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">the_attribute</span>.<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-identifier">direction_key</span> = <span class="ruby-value">:output</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">direction_key</span>
|
||||
<span class="ruby-identifier">parameters</span> = {}
|
||||
<span class="ruby-identifier">the_message</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_part</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_part</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Oga</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Element</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_part</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"part"</span>
|
||||
<span class="ruby-identifier">the_name</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">the_type</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">the_part</span>.<span class="ruby-identifier">attributes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_parameter</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_parameter</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"name"</span>
|
||||
<span class="ruby-identifier">the_name</span> = <span class="ruby-identifier">the_parameter</span>.<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_parameter</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"type"</span>
|
||||
<span class="ruby-identifier">the_type</span> = <span class="ruby-identifier">the_parameter</span>.<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_parameter</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"element"</span>
|
||||
<span class="ruby-identifier">the_type</span> = <span class="ruby-identifier">the_parameter</span>.<span class="ruby-identifier">value</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_name</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">the_type</span>)
|
||||
<span class="ruby-identifier">parameters</span>[(<span class="ruby-identifier">the_name</span>.<span class="ruby-identifier">to_sym</span>)] = <span class="ruby-identifier">the_type</span>
|
||||
<span class="ruby-identifier">the_name</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">the_type</span> = <span class="ruby-keyword">nil</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">if</span> <span class="ruby-identifier">parameters</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">record</span>[(<span class="ruby-identifier">direction_key</span>)] = <span class="ruby-identifier">parameters</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">if</span> <span class="ruby-identifier">record</span>[<span class="ruby-value">:input</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">record</span>[<span class="ruby-value">:output</span>]
|
||||
<span class="ruby-ivar">@interface</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">record</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"Failed to retrieve WSDL data."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"No WSDL endpoint detected (required)."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">self</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-interface" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">interface</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="interface-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2228</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">interface</span>()
|
||||
<span class="ruby-ivar">@interface</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-on_before_dispatch" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">on_before_dispatch</span><span
|
||||
class="method-args">(the_document=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="on_before_dispatch-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2218</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">on_before_dispatch</span>(<span class="ruby-identifier">the_document</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-on_create_document" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">on_create_document</span><span
|
||||
class="method-args">(the_document=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Handsoap support hooks:</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="on_create_document-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2212</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">on_create_document</span>(<span class="ruby-identifier">the_document</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@tns_url</span>
|
||||
<span class="ruby-identifier">the_document</span>.<span class="ruby-identifier">alias</span>(<span class="ruby-string">'tns'</span>, <span class="ruby-ivar">@tns_url</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-on_response_document" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">on_response_document</span><span
|
||||
class="method-args">(the_document=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="on_response_document-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2222</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">on_response_document</span>(<span class="ruby-identifier">the_document</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@tns_url</span>
|
||||
<span class="ruby-identifier">the_document</span>.<span class="ruby-identifier">add_namespace</span>(<span class="ruby-string">'ns'</span>, <span class="ruby-ivar">@tns_url</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.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>
|
||||
|
||||
628
doc/GxG/Networking/SshClient.html
Normal file
628
doc/GxG/Networking/SshClient.html
Normal file
|
|
@ -0,0 +1,628 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::SshClient - 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-async_download">#async_download</a>
|
||||
|
||||
<li ><a href="#method-i-async_upload">#async_upload</a>
|
||||
|
||||
<li ><a href="#method-i-channel_operations">#channel_operations</a>
|
||||
|
||||
<li ><a href="#method-i-closed-3F">#closed?</a>
|
||||
|
||||
<li ><a href="#method-i-download">#download</a>
|
||||
|
||||
<li ><a href="#method-i-login">#login</a>
|
||||
|
||||
<li ><a href="#method-i-logout">#logout</a>
|
||||
|
||||
<li ><a href="#method-i-send_command">#send_command</a>
|
||||
|
||||
<li ><a href="#method-i-upload">#upload</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::SshClient">
|
||||
<h1 id="class-GxG::Networking::SshClient" class="class">
|
||||
class GxG::Networking::SshClient
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>SSH Client</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">()</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/gxg/net_clients.rb, line 4138</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">self</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-async_download" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">async_download</span><span
|
||||
class="method-args">(the_remote_source=nil, the_destination=nil, options={}, &progress_block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="async_download-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4271</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">async_download</span>(<span class="ruby-identifier">the_remote_source</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_destination</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_remote_source</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a local path as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_destination</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a remote path as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">progress_block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">channel</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download</span>(<span class="ruby-identifier">the_remote_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">channel</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download</span>(<span class="ruby-identifier">the_remote_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">wait</span>
|
||||
<span class="ruby-comment"># True result means the request was sent, not that it completed.</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:remote_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_remote_source</span>, <span class="ruby-value">:local_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_destination</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-async_upload" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">async_upload</span><span
|
||||
class="method-args">(the_local_source=nil, the_destination=nil, options={}, &progress_block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="async_upload-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4214</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">async_upload</span>(<span class="ruby-identifier">the_local_source</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_destination</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_local_source</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a local path as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_destination</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a remote path as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">progress_block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">channel</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload</span>(<span class="ruby-identifier">the_local_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">channel</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload</span>(<span class="ruby-identifier">the_local_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">wait</span>
|
||||
<span class="ruby-comment"># True result means the request was sent, not that it completed.</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:local_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_local_source</span>, <span class="ruby-value">:remote_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_destination</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-channel_operations" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">channel_operations</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="channel_operations-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4176</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">channel_operations</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid Block/Proc to execute."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">open_channel</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:block</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">block</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-closed-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">closed?</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="closed-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4206</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-download" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">download</span><span
|
||||
class="method-args">(the_remote_source=nil, the_destination=nil, options={}, &progress_block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="download-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4296</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download</span>(<span class="ruby-identifier">the_remote_source</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_destination</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-comment"># options:</span>
|
||||
<span class="ruby-comment">#:recursive - the local parameter refers to a local directory, which should be uploaded to a new directory named remote</span>
|
||||
<span class="ruby-comment"># on the remote server.</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment">#:preserve - the atime and mtime of the file should be preserved.</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment">#:verbose - the process should result in verbose output on the server end (useful for debugging).</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_remote_source</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a remote path as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_destination</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a local path (or file name) as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">progress_block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download!</span>(<span class="ruby-identifier">the_remote_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">download!</span>(<span class="ruby-identifier">the_remote_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:remote_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_remote_source</span>, <span class="ruby-value">:local_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_destination</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-login" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">login</span><span
|
||||
class="method-args">(the_url=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="login-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4143</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:password</span>] = <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span>.<span class="ruby-identifier">start</span>(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>, <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-logout" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">logout</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="logout-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4192</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-ivar">@client</span>.<span class="ruby-identifier">exec!</span>(<span class="ruby-string">"exit"</span>)
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-send_command" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">send_command</span><span
|
||||
class="method-args">(the_command=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="send_command-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4160</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_command</span>(<span class="ruby-identifier">the_command</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_command</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a command as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">exec!</span>(<span class="ruby-identifier">the_command</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:command</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_command</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-upload" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">upload</span><span
|
||||
class="method-args">(the_local_source=nil, the_destination=nil, options={}, &progress_block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="upload-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 4239</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">upload</span>(<span class="ruby-identifier">the_local_source</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_destination</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-comment"># options:</span>
|
||||
<span class="ruby-comment">#:recursive - the local parameter refers to a local directory, which should be uploaded to a new directory named remote</span>
|
||||
<span class="ruby-comment"># on the remote server.</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment">#:preserve - the atime and mtime of the file should be preserved.</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment">#:verbose - the process should result in verbose output on the server end (useful for debugging).</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment">#:chunk_size - the size of each "chunk" that should be sent. Defaults to 2048. Changing this value may</span>
|
||||
<span class="ruby-comment"># improve throughput at the expense of decreasing interactivity.</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_local_source</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a local path as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_destination</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a remote path as a String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">progress_block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload!</span>(<span class="ruby-identifier">the_local_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">progress_block</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">scp</span>.<span class="ruby-identifier">upload!</span>(<span class="ruby-identifier">the_local_source</span>, <span class="ruby-identifier">the_destination</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:local_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_local_source</span>, <span class="ruby-value">:remote_path</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_destination</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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>
|
||||
|
||||
443
doc/GxG/Networking/XmlrpcClient.html
Normal file
443
doc/GxG/Networking/XmlrpcClient.html
Normal file
|
|
@ -0,0 +1,443 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::XmlrpcClient - 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-callmethod">#callmethod</a>
|
||||
|
||||
<li ><a href="#method-i-closed-3F">#closed?</a>
|
||||
|
||||
<li ><a href="#method-i-interface">#interface</a>
|
||||
|
||||
<li ><a href="#method-i-login">#login</a>
|
||||
|
||||
<li ><a href="#method-i-logout">#logout</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::XmlrpcClient">
|
||||
<h1 id="class-GxG::Networking::XmlrpcClient" class="class">
|
||||
class GxG::Networking::XmlrpcClient
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>XMLRPC Classes:</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">()</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/gxg/net_clients.rb, line 2341</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>()
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-ivar">@interface</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">self</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-callmethod" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">callmethod</span><span
|
||||
class="method-args">(the_method = nil, arguments = nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="callmethod-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2404</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">callmethod</span>(<span class="ruby-identifier">the_method</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">arguments</span> = <span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-comment"># The +method+ parameter is converted into a String and should</span>
|
||||
<span class="ruby-comment"># be a valid XML-RPC method-name.</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment"># Each parameter of +args+ must be of one of the following types,</span>
|
||||
<span class="ruby-comment"># where Hash, Struct and Array can contain any of these listed _types_:</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment"># * Fixnum, Bignum</span>
|
||||
<span class="ruby-comment"># * TrueClass, FalseClass, +true+, +false+</span>
|
||||
<span class="ruby-comment"># * String, Symbol</span>
|
||||
<span class="ruby-comment"># * Float</span>
|
||||
<span class="ruby-comment"># * Hash, Struct</span>
|
||||
<span class="ruby-comment"># * Array</span>
|
||||
<span class="ruby-comment"># * Date, Time, XMLRPC::DateTime</span>
|
||||
<span class="ruby-comment"># * XMLRPC::Base64</span>
|
||||
<span class="ruby-comment"># * A Ruby object which class includes XMLRPC::Marshallable</span>
|
||||
<span class="ruby-comment"># (only if Config::ENABLE_MARSHALLABLE is +true+).</span>
|
||||
<span class="ruby-comment"># That object is converted into a hash, with one additional key/value</span>
|
||||
<span class="ruby-comment"># pair <code>___class___</code> which contains the class name</span>
|
||||
<span class="ruby-comment"># for restoring that object later.</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_method</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid method String."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-identifier">calldata</span> = []
|
||||
<span class="ruby-identifier">calldata</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_method</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-comment"># TODO: scour arguments structure for type conversions to be done.</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">calldata</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">entry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arguments</span>
|
||||
<span class="ruby-identifier">calldata</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">arguments</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">calldata</span>)
|
||||
<span class="ruby-comment"># TODO: scour result structure for type conversions to gxg standard.</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:method</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_method</span>, <span class="ruby-value">:arguments</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">arguments</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-closed-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">closed?</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="closed-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2396</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-interface" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">interface</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="interface-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2452</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">interface</span>()
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@client</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@interface</span>
|
||||
<span class="ruby-ivar">@interface</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">call</span>(<span class="ruby-string">"interface"</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@interface</span>
|
||||
<span class="ruby-ivar">@interface</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">call</span>(<span class="ruby-string">"Interface"</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-comment"># log_error({:error => the_error, :parameters => {}})</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@interface</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-login" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">login</span><span
|
||||
class="method-args">(the_url=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="login-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2347</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">login</span>(<span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">'https'</span>
|
||||
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">path</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">443</span>)]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> = [(<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">hostname</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">path</span>), (<span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">80</span>)]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</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">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">host</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:proxy</span>].<span class="ruby-identifier">port</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">user</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">password</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:use_ssl</span>] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">'https'</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:timeout</span>].<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">client_parameters</span> <span class="ruby-operator"><<</span> <span class="ruby-value">30</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-operator">::</span><span class="ruby-constant">XMLRPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">client_parameters</span>)
|
||||
<span class="ruby-identifier">this</span>().<span class="ruby-identifier">interface</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:url</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_url</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-logout" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">logout</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="logout-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2391</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logout</span>()
|
||||
<span class="ruby-ivar">@client</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
2656
doc/GxG/Networking/XmppAgent.html
Normal file
2656
doc/GxG/Networking/XmppAgent.html
Normal file
File diff suppressed because it is too large
Load diff
927
doc/GxG/Networking/XmppAgentConversation.html
Normal file
927
doc/GxG/Networking/XmppAgentConversation.html
Normal file
|
|
@ -0,0 +1,927 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::XmppAgentConversation - 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-5B-5D">#[]</a>
|
||||
|
||||
<li ><a href="#method-i-add_message">#add_message</a>
|
||||
|
||||
<li ><a href="#method-i-change_configuration">#change_configuration</a>
|
||||
|
||||
<li ><a href="#method-i-chat_buddies">#chat_buddies</a>
|
||||
|
||||
<li ><a href="#method-i-closed-3F">#closed?</a>
|
||||
|
||||
<li ><a href="#method-i-configuration">#configuration</a>
|
||||
|
||||
<li ><a href="#method-i-default_room_configuration">#default_room_configuration</a>
|
||||
|
||||
<li ><a href="#method-i-inspect">#inspect</a>
|
||||
|
||||
<li ><a href="#method-i-jid">#jid</a>
|
||||
|
||||
<li ><a href="#method-i-join">#join</a>
|
||||
|
||||
<li ><a href="#method-i-leave">#leave</a>
|
||||
|
||||
<li ><a href="#method-i-my_jid">#my_jid</a>
|
||||
|
||||
<li ><a href="#method-i-process_received">#process_received</a>
|
||||
|
||||
<li ><a href="#method-i-say_something">#say_something</a>
|
||||
|
||||
<li ><a href="#method-i-send_invitations">#send_invitations</a>
|
||||
|
||||
<li ><a href="#method-i-title">#title</a>
|
||||
|
||||
<li ><a href="#method-i-uuid">#uuid</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::XmppAgentConversation">
|
||||
<h1 id="class-GxG::Networking::XmppAgentConversation" class="class">
|
||||
class GxG::Networking::XmppAgentConversation
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>Conversation Channel</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">(parent=nil, details={})</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/gxg/net_clients.rb, line 2935</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">parent</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">details</span>={})
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">valid_uuid?</span>(<span class="ruby-identifier">details</span>[<span class="ruby-value">:context</span>])
|
||||
<span class="ruby-ivar">@uuid</span> = <span class="ruby-identifier">details</span>[<span class="ruby-value">:context</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@uuid</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@parent</span> = <span class="ruby-identifier">parent</span>
|
||||
<span class="ruby-comment"># @details should have a JID for the sender-jid/room-jid</span>
|
||||
<span class="ruby-comment"># @details should indicate whether a private direct message or MUC ROOM message (:chat? or :groupchat?)</span>
|
||||
<span class="ruby-ivar">@details</span> = <span class="ruby-identifier">details</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-ivar">@received</span> = []
|
||||
<span class="ruby-ivar">@received_thread_safety</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
|
||||
<span class="ruby-comment"># Add call backs</span>
|
||||
<span class="ruby-comment"># @parent.notify({:event => :new_message, :conversation => @uuid, :message => message.id})</span>
|
||||
<span class="ruby-comment"># @parent.notify({:event => :new_private_message, :conversation => @uuid, :message => message.id})</span>
|
||||
<span class="ruby-keyword">self</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-5B-5D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">[]</span><span
|
||||
class="method-args">(the_key=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="5B-5D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2970</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">the_key</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_key</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@details</span>[(<span class="ruby-identifier">the_key</span>)]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-add_message" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">add_message</span><span
|
||||
class="method-args">(the_message=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="add_message-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3019</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_message</span>(<span class="ruby-identifier">the_message</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_message</span>
|
||||
<span class="ruby-ivar">@received_thread_safety</span>.<span class="ruby-identifier">synchronize</span> { <span class="ruby-ivar">@received</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_message</span> }
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-i-change_configuration" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">change_configuration</span><span
|
||||
class="method-args">(the_configuration=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="change_configuration-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3120</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change_configuration</span>(<span class="ruby-identifier">the_configuration</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># Review : TODO - alter ROOM configuration if admin/owner</span>
|
||||
<span class="ruby-comment"># if @handler</span>
|
||||
<span class="ruby-comment"># if @handler.owner?</span>
|
||||
<span class="ruby-comment"># unless the_configuration.is_a?(::Hash)</span>
|
||||
<span class="ruby-comment"># raise ArgumentError, "You MUST provide a configuration Hash."</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># the_configuration = this().default_room_configuration(the_configuration)</span>
|
||||
<span class="ruby-comment"># @handler.submit_room_configuration(the_configuration)</span>
|
||||
<span class="ruby-comment"># result = true</span>
|
||||
<span class="ruby-comment"># else</span>
|
||||
<span class="ruby-comment"># raise Exception, "You are not the owner of this conversation room."</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:configuration</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_configuration</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-chat_buddies" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">chat_buddies</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="chat_buddies-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3049</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">chat_buddies</span>()
|
||||
<span class="ruby-identifier">result</span> = []
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># Review : TODO - like XmppAgent.buddies but for this ROOM only.</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-closed-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">closed?</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="closed-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2988</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">closed?</span>()
|
||||
<span class="ruby-comment"># Review : integrate with new system</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-configuration" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">configuration</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="configuration-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3086</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">configuration</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># Review : TODO - get ROOM configuration</span>
|
||||
<span class="ruby-comment"># if @handler</span>
|
||||
<span class="ruby-comment"># if @handler.owner?</span>
|
||||
<span class="ruby-comment"># current_configuration = {}</span>
|
||||
<span class="ruby-comment"># iq = ::Jabber::Iq.new(:get, @handler.jid.to_s)</span>
|
||||
<span class="ruby-comment"># iq.to = @handler.jid.to_s</span>
|
||||
<span class="ruby-comment"># iq.from = @handler.my_jid.to_s</span>
|
||||
<span class="ruby-comment"># iq.add(::Jabber::MUC::IqQueryMUCOwner.new)</span>
|
||||
<span class="ruby-comment"># field_keys = this().default_room_configuration.keys</span>
|
||||
<span class="ruby-comment"># response = @stream.send_with_id(iq)</span>
|
||||
<span class="ruby-comment"># if response</span>
|
||||
<span class="ruby-comment"># if (response.query && response.query.x(::Jabber::Dataforms::XData))</span>
|
||||
<span class="ruby-comment"># field_keys.each do |the_key|</span>
|
||||
<span class="ruby-comment"># field = response.query.x(::Jabber::Dataforms::XData).field(the_key.to_s)</span>
|
||||
<span class="ruby-comment"># if field.is_a?(::Jabber::Dataforms::XDataField)</span>
|
||||
<span class="ruby-comment"># current_configuration[(the_key.to_s)] = field.value</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># result = current_configuration</span>
|
||||
<span class="ruby-comment"># else</span>
|
||||
<span class="ruby-comment"># raise Exception, "You are not the owner of this conversation room."</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-comment"># end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-default_room_configuration" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">default_room_configuration</span><span
|
||||
class="method-args">(options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="default_room_configuration-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2903</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_room_configuration</span>(<span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">default_config</span> = {
|
||||
<span class="ruby-string">'FORM_TYPE'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'http://jabber.org/protocol/muc#roomconfig'</span>,
|
||||
<span class="ruby-string">'form'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'config'</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_roomname'</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_roomdesc'</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>,
|
||||
<span class="ruby-string">'leave'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'has left'</span>,
|
||||
<span class="ruby-string">'join'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'has become available'</span>,
|
||||
<span class="ruby-string">'rename'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'is now known as'</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_changesubject'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_maxusers'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'privacy'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_publicroom'</span> <span class="ruby-operator">=></span> <span class="ruby-value">1</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_persistentroom'</span> <span class="ruby-operator">=></span> <span class="ruby-value">1</span>,
|
||||
<span class="ruby-string">'legacy'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_moderatedroom'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'defaulttype'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'privmsg'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_membersonly'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_allowinvites'</span> <span class="ruby-operator">=></span> <span class="ruby-value">1</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_passwordprotectedroom'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_roomsecret'</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_whois'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'moderators'</span>,
|
||||
<span class="ruby-string">'muc#roomconfig_enablelogging'</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>,
|
||||
<span class="ruby-string">'logformat'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'xml'</span>
|
||||
}
|
||||
<span class="ruby-identifier">default_config</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-inspect" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">inspect</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="inspect-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2984</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>()
|
||||
{<span class="ruby-value">:jid</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">this</span>().<span class="ruby-identifier">jid</span>, <span class="ruby-value">:title</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">this</span>().<span class="ruby-identifier">title</span>}.<span class="ruby-identifier">inspect</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-jid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">jid</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="jid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2958</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">jid</span>()
|
||||
<span class="ruby-ivar">@details</span>[<span class="ruby-value">:sender</span>].<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-join" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">join</span><span
|
||||
class="method-args">(the_jid=nil, password=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="join-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3028</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">join</span>(<span class="ruby-identifier">the_jid</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">password</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># Review : TODO - MUC join</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:the_jid</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_jid</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-leave" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">leave</span><span
|
||||
class="method-args">(exit_string=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="leave-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3038</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">leave</span>(<span class="ruby-identifier">exit_string</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># Review : TODO - MUC leave</span>
|
||||
<span class="ruby-comment"># @parent.refresh_conversations</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:exit_string</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">exit_string</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-my_jid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">my_jid</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="my_jid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2962</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">my_jid</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@parent</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">jid</span>().<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process_received" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_received</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process_received-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2993</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_received</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">count</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-ivar">@received_thread_safety</span>.<span class="ruby-identifier">synchronize</span> {
|
||||
<span class="ruby-identifier">count</span> = <span class="ruby-ivar">@received</span>.<span class="ruby-identifier">size</span>
|
||||
}
|
||||
<span class="ruby-identifier">record</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">count</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-ivar">@received_thread_safety</span>.<span class="ruby-identifier">synchronize</span> {
|
||||
<span class="ruby-identifier">record</span> = <span class="ruby-ivar">@received</span>.<span class="ruby-identifier">shift</span>
|
||||
}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">record</span>
|
||||
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">record</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {}})
|
||||
<span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-say_something" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">say_something</span><span
|
||||
class="method-args">(the_message=nil, to_jid=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="say_something-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3059</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">say_something</span>(<span class="ruby-identifier">the_message</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">to_jid</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@details</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:chat</span>
|
||||
<span class="ruby-identifier">recipient</span> = (<span class="ruby-identifier">to_jid</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">the_message</span>[<span class="ruby-value">:to</span>]).<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">say</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">JID</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">recipient</span>), <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">gxg_message_to_xmpp</span>(<span class="ruby-identifier">the_message</span>))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># Review : TODO - send chat message to ROOM</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:message</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_message</span>, <span class="ruby-value">:to</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">to_jid</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-send_invitations" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">send_invitations</span><span
|
||||
class="method-args">(the_recipients=nil, reason=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="send_invitations-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 3075</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send_invitations</span>(<span class="ruby-identifier">the_recipients</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">reason</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># Review : TODO - ROOM invitation list processing list.each { |i| send i }</span>
|
||||
<span class="ruby-comment"># "You MUST provide an Array of JID Strings."</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>
|
||||
<span class="ruby-identifier">log_error</span>({<span class="ruby-value">:error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_error</span>, <span class="ruby-value">:parameters</span> <span class="ruby-operator">=></span> {<span class="ruby-value">:recipients</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">the_recipients</span>, <span class="ruby-value">:message</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">reason</span>}})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-title" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">title</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="title-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2978</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">title</span>()
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-comment"># Review : TODO - return ROOM title</span>
|
||||
<span class="ruby-identifier">result</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-uuid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">uuid</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="uuid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2954</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uuid</span>()
|
||||
<span class="ruby-ivar">@uuid</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>
|
||||
|
||||
1048
doc/GxG/Networking/XmppAgentFileTransfer.html
Normal file
1048
doc/GxG/Networking/XmppAgentFileTransfer.html
Normal file
File diff suppressed because it is too large
Load diff
470
doc/GxG/Networking/XmppAgentInvitation.html
Normal file
470
doc/GxG/Networking/XmppAgentInvitation.html
Normal file
|
|
@ -0,0 +1,470 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::XmppAgentInvitation - 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-5B-5D">#[]</a>
|
||||
|
||||
<li ><a href="#method-i-accept">#accept</a>
|
||||
|
||||
<li ><a href="#method-i-decline">#decline</a>
|
||||
|
||||
<li ><a href="#method-i-inspect">#inspect</a>
|
||||
|
||||
<li ><a href="#method-i-invitation">#invitation</a>
|
||||
|
||||
<li ><a href="#method-i-keys">#keys</a>
|
||||
|
||||
<li ><a href="#method-i-pending-3F">#pending?</a>
|
||||
|
||||
<li ><a href="#method-i-uuid">#uuid</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::XmppAgentInvitation">
|
||||
<h1 id="class-GxG::Networking::XmppAgentInvitation" class="class">
|
||||
class GxG::Networking::XmppAgentInvitation
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
<p>XMPP Classes: Review : <a href="../../Blather.html"><code>Blather</code></a> switchover: require ::File.expand_path(“./xmpp_client.rb”,::File.dirname(__FILE__)) ### Invitations</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">(parent=nil, invitation=nil)</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/gxg/net_clients.rb, line 2474</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">parent</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">invitation</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-ivar">@uuid</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-ivar">@pending</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@parent</span> = <span class="ruby-identifier">parent</span>
|
||||
<span class="ruby-ivar">@invitation</span> = <span class="ruby-identifier">invitation</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@invitation</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Blather</span><span class="ruby-operator">::</span><span class="ruby-constant">Stanza</span><span class="ruby-operator">::</span><span class="ruby-constant">Presence</span>)
|
||||
<span class="ruby-ivar">@details</span> = {<span class="ruby-value">:sender</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@invitation</span>.<span class="ruby-identifier">from</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-value">:association</span>}
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@details</span> = {<span class="ruby-value">:sender</span> <span class="ruby-operator">=></span> <span class="ruby-ivar">@invitation</span>.<span class="ruby-identifier">from</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">:type</span> <span class="ruby-operator">=></span> <span class="ruby-value">:unkown</span>}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">self</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-5B-5D" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">[]</span><span
|
||||
class="method-args">(the_key)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="5B-5D-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2509</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">the_key</span>)
|
||||
<span class="ruby-ivar">@details</span>[(<span class="ruby-identifier">the_key</span>)]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-accept" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">accept</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="accept-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2513</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">accept</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@invitation</span>
|
||||
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">write</span>(<span class="ruby-ivar">@invitation</span>.<span class="ruby-identifier">approve!</span>)
|
||||
<span class="ruby-ivar">@pending</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">refresh_invitations</span>()
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-i-decline" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">decline</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="decline-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2524</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">decline</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@invitation</span>
|
||||
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">write</span>(<span class="ruby-ivar">@invitation</span>.<span class="ruby-identifier">cancel!</span>)
|
||||
<span class="ruby-ivar">@pending</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">refresh_invitations</span>()
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-i-inspect" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">inspect</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="inspect-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2497</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>()
|
||||
<span class="ruby-ivar">@details</span>.<span class="ruby-identifier">inspect</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-invitation" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">invitation</span><span
|
||||
class="method-args">()</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Review : debug only</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="invitation-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2489</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">invitation</span>()
|
||||
<span class="ruby-ivar">@invitation</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-keys" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">keys</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="keys-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2505</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">keys</span>()
|
||||
<span class="ruby-ivar">@details</span>.<span class="ruby-identifier">keys</span>()
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-pending-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">pending?</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="pending-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2501</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pending?</span>()
|
||||
<span class="ruby-ivar">@pending</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-uuid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">uuid</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="uuid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/net_clients.rb, line 2493</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uuid</span>()
|
||||
<span class="ruby-ivar">@uuid</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>
|
||||
|
||||
187
doc/GxG/Networking/ZMQ.html
Normal file
187
doc/GxG/Networking/ZMQ.html
Normal file
|
|
@ -0,0 +1,187 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Networking::ZMQ - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-c-zmq_default_context">::zmq_default_context</a>
|
||||
|
||||
<li ><a href="#method-c-zmq_supported_protocols">::zmq_supported_protocols</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Networking::ZMQ">
|
||||
<h1 id="module-GxG::Networking::ZMQ" class="module">
|
||||
module GxG::Networking::ZMQ
|
||||
</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-zmq_default_context" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">zmq_default_context</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="zmq_default_context-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 25</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">zmq_default_context</span>()
|
||||
<span class="ruby-identifier">@@details</span>[<span class="ruby-value">:zmq_context</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-c-zmq_supported_protocols" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">zmq_supported_protocols</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="zmq_supported_protocols-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 29</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">zmq_supported_protocols</span>()
|
||||
<span class="ruby-keyword">if</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">platform</span>()[<span class="ruby-value">:platform</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:windows</span>
|
||||
[<span class="ruby-string">"inproc"</span>, <span class="ruby-string">"tcp"</span>, <span class="ruby-string">"tcp4"</span>, <span class="ruby-string">"tcp6"</span>, <span class="ruby-string">"pgm"</span>, <span class="ruby-string">"epgm"</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
[<span class="ruby-string">"inproc"</span>, <span class="ruby-string">"ipc"</span>, <span class="ruby-string">"tcp"</span>, <span class="ruby-string">"tcp4"</span>, <span class="ruby-string">"tcp6"</span>, <span class="ruby-string">"pgm"</span>, <span class="ruby-string">"epgm"</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.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>
|
||||
|
||||
503
doc/GxG/Networking/ZMQ/ZmqAdapter.html
Normal file
503
doc/GxG/Networking/ZMQ/ZmqAdapter.html
Normal file
|
|
@ -0,0 +1,503 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqAdapter - 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-i-close">#close</a>
|
||||
|
||||
<li ><a href="#method-i-context">#context</a>
|
||||
|
||||
<li ><a href="#method-i-identity">#identity</a>
|
||||
|
||||
<li ><a href="#method-i-listen">#listen</a>
|
||||
|
||||
<li ><a href="#method-i-open-3F">#open?</a>
|
||||
|
||||
<li ><a href="#method-i-receive">#receive</a>
|
||||
|
||||
<li ><a href="#method-i-send">#send</a>
|
||||
|
||||
<li ><a href="#method-i-socket">#socket</a>
|
||||
|
||||
<li ><a href="#method-i-vetted_parameters">#vetted_parameters</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqAdapter">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqAdapter" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqAdapter
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-close" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">close</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="close-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 101</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">close</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">false</span>
|
||||
<span class="ruby-keyword">true</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>
|
||||
|
||||
|
||||
<div id="method-i-context" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">context</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="context-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 111</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">context</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">context</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-identity" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">identity</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="identity-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 123</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">identity</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-listen" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">listen</span><span
|
||||
class="method-args">(&block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="listen-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 129</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">listen</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">listen</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-open-3F" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">open?</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="open-3F-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 97</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">open?</span>()
|
||||
<span class="ruby-ivar">@open</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-receive" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">receive</span><span
|
||||
class="method-args">(**options, &block)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="receive-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 135</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">receive</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">receive</span>(<span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-send" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">send</span><span
|
||||
class="method-args">(message="", **options)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="send-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 141</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send</span>(<span class="ruby-identifier">message</span>=<span class="ruby-string">""</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">message</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-socket" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">socket</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="socket-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 117</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">socket</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-vetted_parameters" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">vetted_parameters</span><span
|
||||
class="method-args">(params={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<pre>Proposed: {:bind/connect => <URI>, :context => <Context>, :encode => <Proc>, :decode => <Proc>}
|
||||
mode (:bind, :connect) — a mode for the socket.
|
||||
Options Hash:</pre>
|
||||
|
||||
<p>context (ZMQ::Context) — a context to use for this socket (one will be created if not provided). encode (lambda) — how to encode messages. decode (lambda) — how to decode messages. transport (Symbol) — default: :tcp — transport for transport. address (String) — default: '127.0.0.1' — address for endpoint. port (Fixnum) — default: 5555 — port for endpoint.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="vetted_parameters-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 47</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">vetted_parameters</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a Hash as parameters."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:bind</span>]
|
||||
<span class="ruby-comment"># bind</span>
|
||||
<span class="ruby-identifier">mode</span> = <span class="ruby-value">:bind</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># connect</span>
|
||||
<span class="ruby-identifier">mode</span> = <span class="ruby-value">:connect</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:context</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">ZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Context</span>)
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:context</span>] = <span class="ruby-identifier">params</span>[<span class="ruby-value">:context</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">uri</span> = <span class="ruby-identifier">params</span>[(<span class="ruby-identifier">mode</span>)].<span class="ruby-identifier">clone</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span>
|
||||
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span> = <span class="ruby-value">5555</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:port</span>] = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">uri</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">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URI to bind or connect to."</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">ZMQ</span><span class="ruby-operator">::</span><span class="ruby-identifier">zmq_supported_protocols</span>().<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>())
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">mode</span> <span class="ruby-operator">==</span> <span class="ruby-value">:bind</span>
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-string">"tcp"</span>, <span class="ruby-string">"tcp4"</span>, <span class="ruby-string">"tcp6"</span>, <span class="ruby-string">"udp"</span>, <span class="ruby-string">"udp4"</span>, <span class="ruby-string">"udp6"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>())
|
||||
<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">resolve_host</span>()
|
||||
<span class="ruby-keyword">if</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">network_port_used?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Addrinfo</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-identifier">uri</span>))
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EADDRINUSE</span>, <span class="ruby-node">"Address and port already in use: #{uri.to_s}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-node">"Unsupported networking protocol: #{uri.scheme().inspect}"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:transport</span>] = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:address</span>] = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">hostname</span>
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-string">"tcp"</span>, <span class="ruby-string">"tcp4"</span>, <span class="ruby-string">"tcp6"</span>, <span class="ruby-string">"udp"</span>, <span class="ruby-string">"udp4"</span>, <span class="ruby-string">"udp6"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>())
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:port</span>] = (<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">||</span> <span class="ruby-value">5555</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:transport</span>] = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:encode</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:encode</span>] = <span class="ruby-identifier">params</span>[<span class="ruby-value">:encode</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:decode</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-identifier">options</span>[<span class="ruby-value">:decode</span>] = <span class="ruby-identifier">params</span>[<span class="ruby-value">:decode</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
{<span class="ruby-value">:mode</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">mode</span>, <span class="ruby-value">:options</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">options</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>
|
||||
|
||||
202
doc/GxG/Networking/ZMQ/ZmqClient.html
Normal file
202
doc/GxG/Networking/ZMQ/ZmqClient.html
Normal file
|
|
@ -0,0 +1,202 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqClient - 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="ZmqAdapter.html">GxG::Networking::ZMQ::ZmqAdapter</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-request">#request</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqClient">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqClient" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqClient
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(params={})</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/gxg/gxg_zmq.rb, line 184</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">vetted_parameters</span>(<span class="ruby-identifier">params</span>)
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">EZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:options</span>])
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">self</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-request" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">request</span><span
|
||||
class="method-args">(message="", **options)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="request-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 192</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">request</span>(<span class="ruby-identifier">message</span>=<span class="ruby-string">""</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">request</span>(<span class="ruby-identifier">message</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">options</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>
|
||||
|
||||
104
doc/GxG/Networking/ZMQ/ZmqContext.html
Normal file
104
doc/GxG/Networking/ZMQ/ZmqContext.html
Normal file
|
|
@ -0,0 +1,104 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqContext - 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">EZMQ::Context
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqContext">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqContext" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqContext
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
159
doc/GxG/Networking/ZMQ/ZmqPair.html
Normal file
159
doc/GxG/Networking/ZMQ/ZmqPair.html
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqPair - 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="ZmqAdapter.html">GxG::Networking::ZMQ::ZmqAdapter</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqPair">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqPair" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqPair
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(params={})</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/gxg/gxg_zmq.rb, line 151</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">vetted_parameters</span>(<span class="ruby-identifier">params</span>)
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">EZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Pair</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>], <span class="ruby-identifier">params</span>[<span class="ruby-value">:options</span>])
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">true</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.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>
|
||||
|
||||
204
doc/GxG/Networking/ZMQ/ZmqPublisher.html
Normal file
204
doc/GxG/Networking/ZMQ/ZmqPublisher.html
Normal file
|
|
@ -0,0 +1,204 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqPublisher - 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="ZmqAdapter.html">GxG::Networking::ZMQ::ZmqAdapter</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-send">#send</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqPublisher">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqPublisher" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqPublisher
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(params={})</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/gxg/gxg_zmq.rb, line 209</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">vetted_parameters</span>(<span class="ruby-identifier">params</span>)
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">EZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Publisher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:options</span>])
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">self</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-send" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">send</span><span
|
||||
class="method-args">(message="", topic='', **options)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="send-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 217</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send</span>(<span class="ruby-identifier">message</span>=<span class="ruby-string">""</span>, <span class="ruby-identifier">topic</span>=<span class="ruby-string">''</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">message</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">topic</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">options</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.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>
|
||||
|
||||
159
doc/GxG/Networking/ZMQ/ZmqPuller.html
Normal file
159
doc/GxG/Networking/ZMQ/ZmqPuller.html
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqPuller - 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="ZmqAdapter.html">GxG::Networking::ZMQ::ZmqAdapter</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqPuller">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqPuller" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqPuller
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(params={})</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/gxg/gxg_zmq.rb, line 173</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">vetted_parameters</span>(<span class="ruby-identifier">params</span>)
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">EZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Puller</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>], <span class="ruby-identifier">params</span>[<span class="ruby-value">:options</span>])
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">true</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.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>
|
||||
|
||||
159
doc/GxG/Networking/ZMQ/ZmqPusher.html
Normal file
159
doc/GxG/Networking/ZMQ/ZmqPusher.html
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqPusher - 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="ZmqAdapter.html">GxG::Networking::ZMQ::ZmqAdapter</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqPusher">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqPusher" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqPusher
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(params={})</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/gxg/gxg_zmq.rb, line 162</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">vetted_parameters</span>(<span class="ruby-identifier">params</span>)
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">EZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Pusher</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:mode</span>], <span class="ruby-identifier">params</span>[<span class="ruby-value">:options</span>])
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">true</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.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>
|
||||
|
||||
159
doc/GxG/Networking/ZMQ/ZmqServer.html
Normal file
159
doc/GxG/Networking/ZMQ/ZmqServer.html
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqServer - 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="ZmqAdapter.html">GxG::Networking::ZMQ::ZmqAdapter</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>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqServer">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqServer" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqServer
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(params={})</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/gxg/gxg_zmq.rb, line 198</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">vetted_parameters</span>(<span class="ruby-identifier">params</span>)
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">EZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Server</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:options</span>])
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">true</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.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>
|
||||
|
||||
241
doc/GxG/Networking/ZMQ/ZmqSubscriber.html
Normal file
241
doc/GxG/Networking/ZMQ/ZmqSubscriber.html
Normal file
|
|
@ -0,0 +1,241 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::Networking::ZMQ::ZmqSubscriber - 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="ZmqAdapter.html">GxG::Networking::ZMQ::ZmqAdapter</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-subscribe">#subscribe</a>
|
||||
|
||||
<li ><a href="#method-i-unsubscribe">#unsubscribe</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::Networking::ZMQ::ZmqSubscriber">
|
||||
<h1 id="class-GxG::Networking::ZMQ::ZmqSubscriber" class="class">
|
||||
class GxG::Networking::ZMQ::ZmqSubscriber
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(params={})</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/gxg/gxg_zmq.rb, line 226</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span>={})
|
||||
<span class="ruby-identifier">params</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">vetted_parameters</span>(<span class="ruby-identifier">params</span>)
|
||||
<span class="ruby-ivar">@connector</span> = <span class="ruby-operator">::</span><span class="ruby-constant">EZMQ</span><span class="ruby-operator">::</span><span class="ruby-constant">Subscriber</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:options</span>])
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">identity</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Celluloid</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span><span class="ruby-operator">::</span><span class="ruby-identifier">random_generate</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-ivar">@open</span> = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">self</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-subscribe" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">subscribe</span><span
|
||||
class="method-args">(topic="")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="subscribe-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 234</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">subscribe</span>(<span class="ruby-identifier">topic</span>=<span class="ruby-string">""</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">topic</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-unsubscribe" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">unsubscribe</span><span
|
||||
class="method-args">(topic="")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="unsubscribe-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_zmq.rb, line 240</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unsubscribe</span>(<span class="ruby-identifier">topic</span>=<span class="ruby-string">""</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@open</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">topic</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.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>
|
||||
|
||||
1536
doc/GxG/Networking/ZmqNode.html
Normal file
1536
doc/GxG/Networking/ZmqNode.html
Normal file
File diff suppressed because it is too large
Load diff
411
doc/GxG/ReturnResponse.html
Normal file
411
doc/GxG/ReturnResponse.html
Normal file
|
|
@ -0,0 +1,411 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>class GxG::ReturnResponse - 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-debug">#debug</a>
|
||||
|
||||
<li ><a href="#method-i-error">#error</a>
|
||||
|
||||
<li ><a href="#method-i-info">#info</a>
|
||||
|
||||
<li ><a href="#method-i-inspect">#inspect</a>
|
||||
|
||||
<li ><a href="#method-i-new_selector">#new_selector</a>
|
||||
|
||||
<li ><a href="#method-i-result">#result</a>
|
||||
|
||||
<li ><a href="#method-i-warning">#warning</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="class-GxG::ReturnResponse">
|
||||
<h1 id="class-GxG::ReturnResponse" class="class">
|
||||
class GxG::ReturnResponse
|
||||
</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-new" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new</span><span
|
||||
class="method-args">(response={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>this class allows for characterized muli-part return values for Procs and Methods this was created for a variety of reasons. Hope this isn't a dead end.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="new-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 364</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">response</span>={})
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"Response must be passed as a Hash"</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@details</span> = <span class="ruby-identifier">response</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-debug" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">debug</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="debug-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 385</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">debug</span>()
|
||||
<span class="ruby-ivar">@details</span>[<span class="ruby-value">:debug</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-error" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">error</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="error-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 376</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">error</span>()
|
||||
<span class="ruby-ivar">@details</span>[<span class="ruby-value">:error</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-info" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">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="info-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 382</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">info</span>()
|
||||
<span class="ruby-ivar">@details</span>[<span class="ruby-value">:info</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-inspect" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">inspect</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="inspect-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 388</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>()
|
||||
<span class="ruby-ivar">@details</span>.<span class="ruby-identifier">inspect</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-new_selector" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">new_selector</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="new_selector-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 370</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">new_selector</span>()
|
||||
<span class="ruby-ivar">@details</span>[<span class="ruby-value">:new_selector</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-result" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">result</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="result-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 373</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">result</span>()
|
||||
<span class="ruby-ivar">@details</span>[<span class="ruby-value">:result</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-warning" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">warning</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="warning-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 379</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">warning</span>()
|
||||
<span class="ruby-ivar">@details</span>[<span class="ruby-value">:warning</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>
|
||||
|
||||
97
doc/GxG/Storage.html
Normal file
97
doc/GxG/Storage.html
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Storage - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Storage">
|
||||
<h1 id="module-GxG::Storage" class="module">
|
||||
module GxG::Storage
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
1894
doc/GxG/Storage/FileSpace.html
Normal file
1894
doc/GxG/Storage/FileSpace.html
Normal file
File diff suppressed because it is too large
Load diff
2259
doc/GxG/Storage/Volume.html
Normal file
2259
doc/GxG/Storage/Volume.html
Normal file
File diff suppressed because it is too large
Load diff
97
doc/GxG/Support.html
Normal file
97
doc/GxG/Support.html
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support">
|
||||
<h1 id="module-GxG::Support" class="module">
|
||||
module GxG::Support
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
97
doc/GxG/Support/Library.html
Normal file
97
doc/GxG/Support/Library.html
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support::Library - 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="module">
|
||||
<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>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support::Library">
|
||||
<h1 id="module-GxG::Support::Library" class="module">
|
||||
module GxG::Support::Library
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-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>
|
||||
|
||||
376
doc/GxG/Support/Library/CommonIOPrepare.html
Normal file
376
doc/GxG/Support/Library/CommonIOPrepare.html
Normal file
|
|
@ -0,0 +1,376 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support::Library::CommonIOPrepare - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-i-process_parameters">#process_parameters</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support::Library::CommonIOPrepare">
|
||||
<h1 id="module-GxG::Support::Library::CommonIOPrepare" class="module">
|
||||
module GxG::Support::Library::CommonIOPrepare
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-process_parameters" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_parameters</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="process_parameters-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 769</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_parameters</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
||||
<span class="ruby-identifier">default_object</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-constant">Hash</span>)
|
||||
<span class="ruby-comment"># GxG style parameters</span>
|
||||
<span class="ruby-identifier">raw_params</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:object</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_params_classes_valid</span>())
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:file_descriptor</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_params_classes_valid</span>())
|
||||
<span class="ruby-identifier">default_object</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_params_default_object</span>((<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:object</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:file_descriptor</span>]))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">default_object</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:object</span>] = <span class="ruby-identifier">default_object</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, (<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-identifier">process_params_classes_error</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">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you MUST specify an Array of :mode flags (as symbols)"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_mode_flag</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-keyword">unless</span> [<span class="ruby-value">:read</span>, <span class="ruby-value">:write</span>, <span class="ruby-value">:readwrite</span>, <span class="ruby-value">:create</span>, <span class="ruby-value">:overwrite</span>, <span class="ruby-value">:truncate</span>, <span class="ruby-value">:append</span>, <span class="ruby-value">:text</span>, <span class="ruby-value">:binary</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">the_mode_flag</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">the_mode_flag</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">:binary</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">:text</span>))
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:text</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># standard MRI style parameters</span>
|
||||
<span class="ruby-identifier">raw_params</span> = {<span class="ruby-value">:mode</span> <span class="ruby-operator">=></span> []}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_params_classes_valid</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">Numeric</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:file_descriptor</span>] = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:object</span>] = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">default_object</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">process_params_default_object</span>(<span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">default_object</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:object</span>] = <span class="ruby-identifier">default_object</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, (<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-identifier">process_params_classes_error</span>())
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:mode</span>]
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:mode</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:binmode</span>]
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:binary</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">index</span>(<span class="ruby-value">:text</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:text</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">extern_encode</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">intern_encode</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:encoding</span>]
|
||||
<span class="ruby-identifier">extern_encode</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:encoding</span>]
|
||||
<span class="ruby-identifier">intern_encode</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:encoding</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:external_encoding</span>]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-identifier">extern_encode</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:external_encoding</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:internal_encoding</span>]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">intern_encode</span>
|
||||
<span class="ruby-identifier">intern_encode</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:internal_encoding</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:external_encoding</span>] = <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">intern_encode</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:internal_encoding</span>] = <span class="ruby-identifier">intern_encode</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:autoclose</span>]
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:autoclose</span>] = <span class="ruby-identifier">args</span>[<span class="ruby-value">2</span>][<span class="ruby-value">:autoclose</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-constant">String</span>,<span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>]
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you specify :mode as: 2nd parameter (String || Numeric) or an option in 3rd parameter Hash, but not in both"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] = <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">mode_parse</span> = <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">":"</span>)
|
||||
<span class="ruby-identifier">mode_spec</span> = <span class="ruby-identifier">mode_parse</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">numeric_values</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">mode_spec</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] = <span class="ruby-identifier">mode_spec</span>[<span class="ruby-value">:integer</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] = <span class="ruby-identifier">mode_parse</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">mode_parse</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">extern_encode</span> = <span class="ruby-identifier">mode_parse</span>[<span class="ruby-value">1</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">mode_parse</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">2</span>
|
||||
<span class="ruby-identifier">intern_encode</span> = <span class="ruby-identifier">mode_parse</span>[<span class="ruby-value">2</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">intern_encode</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">extern_encode</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-identifier">intern_encode</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># if specified also in options, it is overwritten here by mode inclusion.</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">extern_encode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">intern_encode</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-comment"># raw_params[:encoding] = extern_encode</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:external_encoding</span>] = <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:internal_encoding</span>] = <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:external_encoding</span>] = <span class="ruby-identifier">extern_encode</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">intern_encode</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:internal_encoding</span>] = <span class="ruby-identifier">intern_encode</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># numeric mode arg</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] = <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_i</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">unless</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:object</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:file_descriptor</span>])
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you MUST specify an IO :object or a :file_descriptor Fixnum"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>]
|
||||
<span class="ruby-comment"># decipher :raw_mode</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-comment"># Numeric</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:file_descriptor</span>]
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">RDWR</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">RDWR</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:read</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">WRONLY</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">WRONLY</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">RDONLY</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">RDONLY</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:read</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">TRUNC</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">TRUNC</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:overwrite</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">APPEND</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">APPEND</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:append</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">CREAT</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">CREAT</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:append</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">RDWR</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">RDWR</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:read</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WRONLY</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WRONLY</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">RDONLY</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">RDONLY</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:read</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">TRUNC</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">TRUNC</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:overwrite</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">APPEND</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">APPEND</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:append</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>] <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">CREAT</span>) <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">CREAT</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:create</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># String</span>
|
||||
<span class="ruby-keyword">unless</span> (<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">:binary</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-value">:text</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"b"</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:binary</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:text</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"r"</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:read</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"+"</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"w"</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:overwrite</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"+"</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:read</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"a"</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:write</span>
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:append</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:raw_mode</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"+"</span>)
|
||||
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator"><<</span> <span class="ruby-value">:read</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">end</span>
|
||||
<span class="ruby-identifier">raw_params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:raw_mode</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:external_encoding</span>]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-identifier">constants</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:external_encoding</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">":external_encoding :#{raw_params[:external_encoding].to_s} unsupported"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:internal_encoding</span>]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-identifier">constants</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:internal_encoding</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">to_sym</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">":internal_encoding :#{raw_params[:internal_encoding].to_s} unsupported"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">raw_params</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>
|
||||
|
||||
218
doc/GxG/Support/Library/IOPrepare.html
Normal file
218
doc/GxG/Support/Library/IOPrepare.html
Normal file
|
|
@ -0,0 +1,218 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support::Library::IOPrepare - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-i-process_params_classes_error">#process_params_classes_error</a>
|
||||
|
||||
<li ><a href="#method-i-process_params_classes_valid">#process_params_classes_valid</a>
|
||||
|
||||
<li ><a href="#method-i-process_params_default_object">#process_params_default_object</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support::Library::IOPrepare">
|
||||
<h1 id="module-GxG::Support::Library::IOPrepare" class="module">
|
||||
module GxG::Support::Library::IOPrepare
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-process_params_classes_error" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_params_classes_error</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="process_params_classes_error-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 761</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_params_classes_error</span>()
|
||||
<span class="ruby-string">"you MUST specify an IO :object or a :file_descriptor Fixnum"</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process_params_classes_valid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_params_classes_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="process_params_classes_valid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 758</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_params_classes_valid</span>()
|
||||
[<span class="ruby-operator">::</span><span class="ruby-constant">IO</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span>, <span class="ruby-operator">::</span><span class="ruby-constant">StringIO</span>, <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">StringIO</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process_params_default_object" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_params_default_object</span><span
|
||||
class="method-args">(the_object=nil)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process_params_default_object-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 755</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_params_default_object</span>(<span class="ruby-identifier">the_object</span>=<span class="ruby-keyword">nil</span>)
|
||||
<span class="ruby-identifier">the_object</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>
|
||||
|
||||
669
doc/GxG/Support/Library/SocketIO.html
Normal file
669
doc/GxG/Support/Library/SocketIO.html
Normal file
|
|
@ -0,0 +1,669 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support::Library::SocketIO - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-i-recv">#recv</a>
|
||||
|
||||
<li ><a href="#method-i-recvmsg">#recvmsg</a>
|
||||
|
||||
<li ><a href="#method-i-send">#send</a>
|
||||
|
||||
<li ><a href="#method-i-sendmsg">#sendmsg</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support::Library::SocketIO">
|
||||
<h1 id="module-GxG::Support::Library::SocketIO" class="module">
|
||||
module GxG::Support::Library::SocketIO
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-recv" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">recv</span><span
|
||||
class="method-args">(bytecount=nil, flags=0)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="recv-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 340</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">recv</span>(<span class="ruby-identifier">bytecount</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">flags</span>=<span class="ruby-value">0</span>)
|
||||
<span class="ruby-comment"># for now, flags ignored. LATER: study Socket.recv message flags in detail</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@before_receive_data</span>)
|
||||
<span class="ruby-ivar">@before_receive_data</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@after_receive_data</span>)
|
||||
<span class="ruby-ivar">@after_receive_data</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">bytecount</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">bytecount</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">buffer_limits</span>(<span class="ruby-value">:in</span>,<span class="ruby-value">:socket</span>)[<span class="ruby-value">:initial</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">flags</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">flags</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fcntl</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">F_GETFL</span>,<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>) <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>
|
||||
<span class="ruby-comment"># on Winderz, just to a buffer sized spoon full until done ??</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to recv on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">call</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UNIXServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UNIXSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:socket</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">TCPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">SOCKSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">TCPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:tcp</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UDPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSource</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:udp</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">buffer_size</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">buffer_limits</span>(<span class="ruby-value">:in</span>,<span class="ruby-identifier">whatfor</span>)[<span class="ruby-value">:initial</span>]
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">bytecount</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">bytecount</span> = <span class="ruby-identifier">buffer_size</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">flags</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-identifier">flags</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># millisecond: 1/1000th of a second (reminder)</span>
|
||||
<span class="ruby-identifier">read_bytes</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-identifier">chunk</span> = <span class="ruby-string">"abc"</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">until</span> (<span class="ruby-identifier">read_bytes</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">bytecount</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">bytesize</span>() <span class="ruby-operator">==</span> <span class="ruby-value">0</span>)
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-keyword">if</span> ((<span class="ruby-identifier">bytecount</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">read_bytes</span>) <span class="ruby-operator"><</span> <span class="ruby-identifier">buffer_size</span>)
|
||||
<span class="ruby-identifier">chunk</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">recv_nonblock</span>((<span class="ruby-identifier">bytecount</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">read_bytes</span>),<span class="ruby-identifier">flags</span>).<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">chunk</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">recv_nonblock</span>(<span class="ruby-identifier">buffer_size</span>,<span class="ruby-identifier">flags</span>).<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">read_bytes</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">bytesize</span>()
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">chunk</span>.<span class="ruby-identifier">bytesize</span>() <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">chunk</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>, <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>, <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>, <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># about 10 ms</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>([<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">until</span> <span class="ruby-identifier">selected</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>([<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">call</span>([<span class="ruby-identifier">result</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0</span>,<span class="ruby-keyword">nil</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</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">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to recv on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">call</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">original_recv</span>(<span class="ruby-identifier">bytecount</span>.<span class="ruby-identifier">to_i</span>,<span class="ruby-identifier">flags</span>).<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">call</span>([<span class="ruby-identifier">result</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0</span>,<span class="ruby-keyword">nil</span>])
|
||||
<span class="ruby-keyword">end</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>
|
||||
|
||||
|
||||
<div id="method-i-recvmsg" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">recvmsg</span><span
|
||||
class="method-args">(max_mesg_length=nil, flags=0, max_control_length=nil, options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="recvmsg-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 281</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">recvmsg</span>(<span class="ruby-identifier">max_mesg_length</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">flags</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">max_control_length</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-comment"># for now, flags ignored. LATER: study Socket.recv message flags in detail</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fcntl</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">F_GETFL</span>,<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>) <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>
|
||||
<span class="ruby-comment"># on Winderz, just to a buffer sized spoon full until done ??</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to recvmsg on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">call</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">recvmsg_nonblock</span>(<span class="ruby-identifier">max_mesg_length</span>, <span class="ruby-identifier">flags</span>, <span class="ruby-identifier">max_control_length</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>, <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>, <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>, <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># about 10 ms</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>([<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">until</span> <span class="ruby-identifier">selected</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>([<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">result</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-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to recvmsg on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">call</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">original_recvmsg</span>(<span class="ruby-identifier">max_mesg_length</span>, <span class="ruby-identifier">flags</span>, <span class="ruby-identifier">max_control_length</span>, <span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">result</span>)
|
||||
<span class="ruby-keyword">end</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>
|
||||
|
||||
|
||||
<div id="method-i-send" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">send</span><span
|
||||
class="method-args">(data="", flags=0, destination_socket_address=nil, *controls)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="send-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 181</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">send</span>(<span class="ruby-identifier">data</span>=<span class="ruby-string">""</span>, <span class="ruby-identifier">flags</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">destination_socket_address</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">controls</span>)
|
||||
<span class="ruby-comment"># for now, flags ignored. LATER: study Socket.send message flags in detail</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@remote_closed</span>)
|
||||
<span class="ruby-ivar">@remote_closed</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@write_latency</span>)
|
||||
<span class="ruby-ivar">@write_latency</span> = {<span class="ruby-value">:low</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:last</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:high</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@before_send_data</span>)
|
||||
<span class="ruby-ivar">@before_send_data</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@after_send_data</span>)
|
||||
<span class="ruby-ivar">@after_send_data</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to send on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">length</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">bytesize</span>() <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">length</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">bytesize</span>()
|
||||
<span class="ruby-comment"># process controls:</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>)
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AF_UNIX</span>, (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:level</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:SOCKET</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SCM_RIGHTS</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:data</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fileno</span>))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">controls</span>.<span class="ruby-identifier">flatten!</span>
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AF_UNIX</span>, (<span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:SOCKET</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SCM_RIGHTS</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">2</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fileno</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UNIXServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UNIXSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:socket</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">TCPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">SOCKSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">TCPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:tcp</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UDPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSource</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:udp</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">buffer_size</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">buffer_limits</span>(<span class="ruby-value">:out</span>,<span class="ruby-identifier">whatfor</span>)[<span class="ruby-value">:initial</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">length</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">buffer_size</span>
|
||||
<span class="ruby-identifier">passes</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">passes_needed</span>(<span class="ruby-identifier">length</span>, <span class="ruby-identifier">buffer_size</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">passes</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">total</span> = (<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-identifier">starting</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">ending</span> = ([<span class="ruby-identifier">length</span>,<span class="ruby-identifier">buffer_size</span>].<span class="ruby-identifier">min</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">passes</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-comment"># if remote end closes during write, raise error.</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>
|
||||
<span class="ruby-identifier">reading</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">latency_reading</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_latency</span>()) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">sendmsg</span>(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">slice_bytes</span>(<span class="ruby-identifier">starting</span><span class="ruby-operator">..</span><span class="ruby-identifier">ending</span>),<span class="ruby-identifier">flags</span>,<span class="ruby-identifier">destination_socket_address</span>,<span class="ruby-identifier">controls</span>) <span class="ruby-keyword">or</span> <span class="ruby-ivar">@remote_closed</span>=<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">destination_socket_address</span>
|
||||
<span class="ruby-identifier">reading</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">latency_reading</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_latency</span>()) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">original_send</span>(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">slice_bytes</span>(<span class="ruby-identifier">starting</span><span class="ruby-operator">..</span><span class="ruby-identifier">ending</span>),<span class="ruby-identifier">flags</span>,<span class="ruby-identifier">destination_socket_address</span>) <span class="ruby-keyword">or</span> <span class="ruby-ivar">@remote_closed</span>=<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">reading</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">latency_reading</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_latency</span>()) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">original_send</span>(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">slice_bytes</span>(<span class="ruby-identifier">starting</span><span class="ruby-operator">..</span><span class="ruby-identifier">ending</span>),<span class="ruby-identifier">flags</span>) <span class="ruby-keyword">or</span> <span class="ruby-ivar">@remote_closed</span>=<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@write_latency</span> = <span class="ruby-identifier">reading</span>[<span class="ruby-value">:reading</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">starting</span> = <span class="ruby-identifier">ending</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">ending</span> = (<span class="ruby-identifier">starting</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">buffer_size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ending</span> <span class="ruby-operator">></span> <span class="ruby-identifier">total</span>
|
||||
<span class="ruby-identifier">ending</span> = <span class="ruby-identifier">ending</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">ending</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">total</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">length</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-sendmsg" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">sendmsg</span><span
|
||||
class="method-args">(data="", flags=0, destination_socket_address=nil, *controls)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="sendmsg-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 8</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sendmsg</span>(<span class="ruby-identifier">data</span>=<span class="ruby-string">""</span>, <span class="ruby-identifier">flags</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">destination_socket_address</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">controls</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@remote_closed</span>)
|
||||
<span class="ruby-ivar">@remote_closed</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@write_latency</span>)
|
||||
<span class="ruby-ivar">@write_latency</span> = {<span class="ruby-value">:low</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:last</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:high</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@before_send_data</span>)
|
||||
<span class="ruby-ivar">@before_send_data</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@after_send_data</span>)
|
||||
<span class="ruby-ivar">@after_send_data</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fcntl</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">F_GETFL</span>,<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>) <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>
|
||||
<span class="ruby-comment"># on Winderz, just to a buffer sized spoon full until done ??</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to sendmsg on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-identifier">written_bytes</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">bytesize</span>()
|
||||
<span class="ruby-comment"># process controls:</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>)
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AF_UNIX</span>, (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:level</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:SOCKET</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SCM_RIGHTS</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:data</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fileno</span>))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">controls</span>.<span class="ruby-identifier">flatten!</span>
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AF_UNIX</span>, (<span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:SOCKET</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SCM_RIGHTS</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">2</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fileno</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you MUST supply ancillary data as a control"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UNIXServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UNIXSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:socket</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">TCPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">SOCKSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">TCPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:tcp</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UDPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSource</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:udp</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">buffer_size</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">buffer_limits</span>(<span class="ruby-value">:out</span>,<span class="ruby-identifier">whatfor</span>)[<span class="ruby-value">:initial</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">written_bytes</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">buffer_size</span>
|
||||
<span class="ruby-identifier">passes</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">passes_needed</span>(<span class="ruby-identifier">written_bytes</span>, <span class="ruby-identifier">buffer_size</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">passes</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">total</span> = (<span class="ruby-identifier">written_bytes</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-identifier">starting</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">ending</span> = ([<span class="ruby-identifier">written_bytes</span>,<span class="ruby-identifier">buffer_size</span>].<span class="ruby-identifier">min</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">passes</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># if remote end closes during write, raise error by setting @remote_closed and breaking loop.</span>
|
||||
<span class="ruby-identifier">reading</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">latency_reading</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_latency</span>()) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">sendmsg_nonblock</span>(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">slice_bytes</span>(<span class="ruby-identifier">starting</span><span class="ruby-operator">..</span><span class="ruby-identifier">ending</span>),<span class="ruby-identifier">flags</span>,<span class="ruby-identifier">destination_socket_address</span>,<span class="ruby-identifier">controls</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-ivar">@write_latency</span> = <span class="ruby-identifier">reading</span>[<span class="ruby-value">:reading</span>]
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>, <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EINTR</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EWOULDBLOCK</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EAGAIN</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>(<span class="ruby-keyword">nil</span>,[<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">until</span> <span class="ruby-identifier">selected</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>(<span class="ruby-keyword">nil</span>,[<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
|
||||
<span class="ruby-ivar">@remote_closed</span>=<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">starting</span> = <span class="ruby-identifier">ending</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">ending</span> = (<span class="ruby-identifier">starting</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">buffer_size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ending</span> <span class="ruby-operator">></span> <span class="ruby-identifier">total</span>
|
||||
<span class="ruby-identifier">ending</span> = <span class="ruby-identifier">ending</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">ending</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">total</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">written_bytes</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-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to sendmsg on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">transcode_to_external</span>(<span class="ruby-identifier">data</span>)
|
||||
<span class="ruby-identifier">written_bytes</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">bytesize</span>()
|
||||
<span class="ruby-comment"># process controls:</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>)
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>]
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AF_UNIX</span>, (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:level</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:SOCKET</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SCM_RIGHTS</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">:data</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fileno</span>))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">controls</span>.<span class="ruby-identifier">flatten!</span>
|
||||
<span class="ruby-identifier">controls</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AncillaryData</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">AF_UNIX</span>, (<span class="ruby-identifier">controls</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:SOCKET</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">SCM_RIGHTS</span>), (<span class="ruby-identifier">controls</span>[<span class="ruby-value">2</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fileno</span>))
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"you MUST supply ancillary data as a control"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UNIXServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UNIXSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:socket</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">TCPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">SOCKSocket</span>, <span class="ruby-operator">::</span><span class="ruby-constant">TCPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:tcp</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">UDPServer</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSource</span>, <span class="ruby-operator">::</span><span class="ruby-constant">UDPSocket</span>)
|
||||
<span class="ruby-identifier">whatfor</span> = <span class="ruby-value">:udp</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">buffer_size</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">buffer_limits</span>(<span class="ruby-value">:out</span>,<span class="ruby-identifier">whatfor</span>)[<span class="ruby-value">:initial</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">written_bytes</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">buffer_size</span>
|
||||
<span class="ruby-identifier">passes</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">passes_needed</span>(<span class="ruby-identifier">written_bytes</span>, <span class="ruby-identifier">buffer_size</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">passes</span> = <span class="ruby-value">1</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">total</span> = (<span class="ruby-identifier">written_bytes</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-identifier">starting</span> = <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">ending</span> = ([<span class="ruby-identifier">written_bytes</span>,<span class="ruby-identifier">buffer_size</span>].<span class="ruby-identifier">min</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">passes</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-comment"># if remote end closes during write, raise error.</span>
|
||||
<span class="ruby-identifier">reading</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">latency_reading</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_latency</span>()) <span class="ruby-keyword">do</span>
|
||||
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">original_sendmsg</span>(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">slice_bytes</span>(<span class="ruby-identifier">starting</span><span class="ruby-operator">..</span><span class="ruby-identifier">ending</span>),<span class="ruby-identifier">flags</span>,<span class="ruby-identifier">destination_socket_address</span>,<span class="ruby-identifier">controls</span>) <span class="ruby-keyword">or</span> <span class="ruby-ivar">@remote_closed</span>=<span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-keyword">break</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-ivar">@write_latency</span> = <span class="ruby-identifier">reading</span>[<span class="ruby-value">:reading</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">starting</span> = <span class="ruby-identifier">ending</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
|
||||
<span class="ruby-identifier">ending</span> = (<span class="ruby-identifier">starting</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">buffer_size</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ending</span> <span class="ruby-operator">></span> <span class="ruby-identifier">total</span>
|
||||
<span class="ruby-identifier">ending</span> = <span class="ruby-identifier">ending</span> <span class="ruby-operator">-</span> (<span class="ruby-identifier">ending</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">total</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@remote_closed</span>
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">written_bytes</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>
|
||||
</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>
|
||||
|
||||
203
doc/GxG/Support/Library/SocketIORecvFrom.html
Normal file
203
doc/GxG/Support/Library/SocketIORecvFrom.html
Normal file
|
|
@ -0,0 +1,203 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support::Library::SocketIORecvFrom - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-i-recvfrom">#recvfrom</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support::Library::SocketIORecvFrom">
|
||||
<h1 id="module-GxG::Support::Library::SocketIORecvFrom" class="module">
|
||||
module GxG::Support::Library::SocketIORecvFrom
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-recvfrom" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">recvfrom</span><span
|
||||
class="method-args">(max_mesg_length=nil, flags=0)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Note: Allow aliases or existing recvfrom_nonblock to catch method references. Do not define recvfrom_nonblock here.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="recvfrom-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 445</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">recvfrom</span>(<span class="ruby-identifier">max_mesg_length</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">flags</span>=<span class="ruby-value">0</span>)
|
||||
<span class="ruby-comment"># for now, flags ignored. LATER: study Socket.recv message flags in detail</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fcntl</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">F_GETFL</span>,<span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>) <span class="ruby-operator">&</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">O_NONBLOCK</span>
|
||||
<span class="ruby-comment"># on Winderz, just to a buffer sized spoon full until done ??</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to recvmsg on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">call</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">recvfrom_nonblock</span>(<span class="ruby-identifier">max_mesg_length</span>, <span class="ruby-identifier">flags</span>)
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>, <span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>, <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>, <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">begin</span>
|
||||
<span class="ruby-comment"># about 10 ms</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>([<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">until</span> <span class="ruby-identifier">selected</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-identifier">selected</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-identifier">select</span>([<span class="ruby-keyword">self</span>],<span class="ruby-keyword">nil</span>,<span class="ruby-keyword">nil</span>,<span class="ruby-value">0.010</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">retry</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">result</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-keyword">self</span>.<span class="ruby-identifier">closed?</span>()
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">IOError</span>, <span class="ruby-string">"attempting to recvmsg on a closed stream"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@before_receive_data</span>.<span class="ruby-identifier">call</span>()
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">original_recvfrom</span>(<span class="ruby-identifier">max_mesg_length</span>, <span class="ruby-identifier">flags</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">result</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
||||
<span class="ruby-ivar">@after_receive_data</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">result</span>)
|
||||
<span class="ruby-keyword">end</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>
|
||||
|
||||
1054
doc/GxG/Support/Library/SocketRW.html
Normal file
1054
doc/GxG/Support/Library/SocketRW.html
Normal file
File diff suppressed because it is too large
Load diff
218
doc/GxG/Support/Library/StringIOPrepare.html
Normal file
218
doc/GxG/Support/Library/StringIOPrepare.html
Normal file
|
|
@ -0,0 +1,218 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support::Library::StringIOPrepare - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-i-process_params_classes_error">#process_params_classes_error</a>
|
||||
|
||||
<li ><a href="#method-i-process_params_classes_valid">#process_params_classes_valid</a>
|
||||
|
||||
<li ><a href="#method-i-process_params_default_object">#process_params_default_object</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support::Library::StringIOPrepare">
|
||||
<h1 id="module-GxG::Support::Library::StringIOPrepare" class="module">
|
||||
module GxG::Support::Library::StringIOPrepare
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-process_params_classes_error" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_params_classes_error</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="process_params_classes_error-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 748</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_params_classes_error</span>()
|
||||
<span class="ruby-string">"you MUST specify a String"</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process_params_classes_valid" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_params_classes_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="process_params_classes_valid-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 745</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_params_classes_valid</span>()
|
||||
[<span class="ruby-operator">::</span><span class="ruby-constant">String</span>]
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-process_params_default_object" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">process_params_default_object</span><span
|
||||
class="method-args">(the_object)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="process_params_default_object-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_io.rb, line 742</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">process_params_default_object</span>(<span class="ruby-identifier">the_object</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.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>
|
||||
|
||||
723
doc/GxG/Support/Library/Transcoding.html
Normal file
723
doc/GxG/Support/Library/Transcoding.html
Normal file
|
|
@ -0,0 +1,723 @@
|
|||
<!DOCTYPE html>
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
|
||||
<title>module GxG::Support::Library::Transcoding - 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="module">
|
||||
<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">
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- Method Quickref -->
|
||||
<div id="method-list-section" class="nav-section">
|
||||
<h3>Methods</h3>
|
||||
|
||||
<ul class="link-list" role="directory">
|
||||
|
||||
<li ><a href="#method-i-convert_to_string">#convert_to_string</a>
|
||||
|
||||
<li ><a href="#method-i-field_separator_used">#field_separator_used</a>
|
||||
|
||||
<li ><a href="#method-i-newline_option_used">#newline_option_used</a>
|
||||
|
||||
<li ><a href="#method-i-newline_used">#newline_used</a>
|
||||
|
||||
<li ><a href="#method-i-prepare_conversion_options">#prepare_conversion_options</a>
|
||||
|
||||
<li ><a href="#method-i-record_separator_used">#record_separator_used</a>
|
||||
|
||||
<li ><a href="#method-i-transcode_to_external">#transcode_to_external</a>
|
||||
|
||||
<li ><a href="#method-i-transcode_to_internal">#transcode_to_internal</a>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<main role="main" aria-labelledby="module-GxG::Support::Library::Transcoding">
|
||||
<h1 id="module-GxG::Support::Library::Transcoding" class="module">
|
||||
module GxG::Support::Library::Transcoding
|
||||
</h1>
|
||||
|
||||
<section class="description">
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="5Buntitled-5D" class="documentation-section">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
||||
<header>
|
||||
<h3>Public Instance Methods</h3>
|
||||
</header>
|
||||
|
||||
|
||||
<div id="method-i-convert_to_string" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">convert_to_string</span><span
|
||||
class="method-args">(the_object=nil,encoding=::Encoding.default_external,conversion_options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="convert_to_string-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 214</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">convert_to_string</span>(<span class="ruby-identifier">the_object</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">encoding</span>=<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">default_external</span>,<span class="ruby-identifier">conversion_options</span>={})
|
||||
<span class="ruby-comment"># return the supplied string, or supported object string data, or UTF_8 codepoint, un-transcoded</span>
|
||||
<span class="ruby-comment"># encoding is used for when a byte value integer is passed to know what encoding to set.</span>
|
||||
<span class="ruby-identifier">the_string</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-identifier">encoding</span> <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">default_external</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_object</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_object</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>)
|
||||
<span class="ruby-identifier">dataset</span> = <span class="ruby-identifier">the_object</span>.<span class="ruby-identifier">flatten</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">dataset</span> = [(<span class="ruby-identifier">the_object</span>)]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">dataset</span>.<span class="ruby-identifier">to_enum</span>(<span class="ruby-value">:each</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">object</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">buffer</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-comment"># find the string content of these classes and pass them for transcoding: Numeric, String, ::IO via gets, ::StringIO via gets, ::GxG::ByteArray</span>
|
||||
<span class="ruby-identifier">buffer</span> = <span class="ruby-identifier">object</span>.<span class="ruby-identifier">dup</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">IO</span>, <span class="ruby-operator">::</span><span class="ruby-constant">StringIO</span>)
|
||||
<span class="ruby-comment"># Note: what issues arise when the_object is in binary mode? Also, how does this scale to very large things or files?</span>
|
||||
<span class="ruby-identifier">buffer</span> = <span class="ruby-identifier">object</span>.<span class="ruby-identifier">gets</span>().<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">ByteArray</span>)
|
||||
<span class="ruby-identifier">buffer</span> = <span class="ruby-identifier">object</span>.<span class="ruby-identifier">to_s</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Numeric</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">>=</span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-value">0xFFFFFFFF</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">to_i</span>) <span class="ruby-operator">></span> <span class="ruby-value">255</span>
|
||||
<span class="ruby-comment"># interprets as unicode code point</span>
|
||||
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">UTF_8</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># interprets as a char value in its own encoding, no transcoding needed.</span>
|
||||
<span class="ruby-identifier">data</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-identifier">encoding</span> <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">default_external</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">buffer</span> = (<span class="ruby-identifier">data</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">to_i</span>)
|
||||
<span class="ruby-identifier">data</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># signed integers not supported for char values or codepoints at this time.</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">==</span> (<span class="ruby-identifier">encoding</span> <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">default_external</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">binmode?</span>())
|
||||
<span class="ruby-identifier">the_string</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># ::String::transcode_options((encoding || ::Encoding.default_external),buffer.encoding, (conversion_options || {}))</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">binmode?</span>()
|
||||
<span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">to_enum</span>(<span class="ruby-value">:chars</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_char</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">the_char</span>.<span class="ruby-identifier">to_enum</span>(<span class="ruby-value">:bytes</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">the_byte</span><span class="ruby-operator">|</span>
|
||||
<span class="ruby-identifier">the_string</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">the_byte</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">nl_op</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">newline_option_used</span>(<span class="ruby-identifier">conversion_options</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">nl_op</span>
|
||||
<span class="ruby-identifier">options</span>[(<span class="ruby-identifier">nl_op</span>)] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">the_string</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">transcode!</span>((<span class="ruby-identifier">encoding</span> <span class="ruby-operator">||</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span>.<span class="ruby-identifier">default_external</span>),<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">the_string</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-field_separator_used" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">field_separator_used</span><span
|
||||
class="method-args">(io_channel=:external)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="field_separator_used-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 162</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">field_separator_used</span>(<span class="ruby-identifier">io_channel</span>=<span class="ruby-value">:external</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@internal_encoding</span>)
|
||||
<span class="ruby-ivar">@internal_encoding</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@internal_field_separator</span>)
|
||||
<span class="ruby-ivar">@internal_field_separator</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@external_field_separator</span>)
|
||||
<span class="ruby-ivar">@external_field_separator</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">field_separator</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">io_channel</span> <span class="ruby-operator">==</span> <span class="ruby-value">:internal</span>
|
||||
<span class="ruby-identifier">field_separator</span>.<span class="ruby-identifier">force_encoding</span>((<span class="ruby-ivar">@internal_encoding</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>))
|
||||
<span class="ruby-identifier">field_separator</span> <span class="ruby-operator"><<</span> (<span class="ruby-ivar">@internal_field_separator</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">$,</span>).<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">io_channel</span> = <span class="ruby-value">:external</span>
|
||||
<span class="ruby-identifier">field_separator</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>)
|
||||
<span class="ruby-identifier">field_separator</span> <span class="ruby-operator"><<</span> (<span class="ruby-ivar">@external_field_separator</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">$,</span>).<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">field_separator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">field_separator</span>
|
||||
<span class="ruby-keyword">else</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-i-newline_option_used" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">newline_option_used</span><span
|
||||
class="method-args">(io_channel=:external)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="newline_option_used-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 103</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">newline_option_used</span>(<span class="ruby-identifier">io_channel</span>=<span class="ruby-value">:external</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@conversion_options</span>)
|
||||
<span class="ruby-ivar">@conversion_options</span> = {<span class="ruby-value">:internal</span> <span class="ruby-operator">=></span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=></span> {}}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># determine the correct new_line trancoding option used</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">io_channel</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">options</span> = <span class="ruby-identifier">io_channel</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">options</span> = (<span class="ruby-ivar">@conversion_options</span>[(<span class="ruby-identifier">io_channel</span>.<span class="ruby-identifier">to_sym</span>)] <span class="ruby-operator">||</span> {})
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:cr_newline</span>]
|
||||
<span class="ruby-value">:cr_newline</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:crlf_newline</span>]
|
||||
<span class="ruby-value">:crlf_newline</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:universal_newline</span>]
|
||||
<span class="ruby-value">:universal_newline</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># use nil if none specified</span>
|
||||
<span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-newline_used" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">newline_used</span><span
|
||||
class="method-args">(io_channel=:external)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="newline_used-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 130</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">newline_used</span>(<span class="ruby-identifier">io_channel</span>=<span class="ruby-value">:external</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@conversion_options</span>)
|
||||
<span class="ruby-ivar">@conversion_options</span> = {<span class="ruby-value">:internal</span> <span class="ruby-operator">=></span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=></span> {}}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@internal_encoding</span>)
|
||||
<span class="ruby-ivar">@internal_encoding</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">newline</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">io_channel</span> <span class="ruby-operator">==</span> <span class="ruby-value">:internal</span>
|
||||
<span class="ruby-identifier">newline</span>.<span class="ruby-identifier">force_encoding</span>((<span class="ruby-ivar">@internal_encoding</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>))
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">io_channel</span> = <span class="ruby-value">:external</span>
|
||||
<span class="ruby-identifier">newline</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment"># determine the correct new_line_separator</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@conversion_options</span>[(<span class="ruby-identifier">io_channel</span>)][<span class="ruby-value">:cr_newline</span>]
|
||||
<span class="ruby-identifier">newline</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\r"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@conversion_options</span>[(<span class="ruby-identifier">io_channel</span>)][<span class="ruby-value">:crlf_newline</span>]
|
||||
<span class="ruby-identifier">newline</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\r\n"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@conversion_options</span>[(<span class="ruby-identifier">io_channel</span>)][<span class="ruby-value">:universal_newline</span>]
|
||||
<span class="ruby-identifier">newline</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># use global default if none specified</span>
|
||||
<span class="ruby-identifier">newline</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">$/</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">newline</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-prepare_conversion_options" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">prepare_conversion_options</span><span
|
||||
class="method-args">(options={})</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>Instance Methods</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="prepare_conversion_options-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 8</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">prepare_conversion_options</span>(<span class="ruby-identifier">options</span>={})
|
||||
<span class="ruby-comment"># obsoleted by ::String::transcode_options</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
||||
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You must pass conversion options parameter as a Hash"</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">new_options</span> = {}
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">valid_options</span> = [<span class="ruby-value">:invalid</span>,<span class="ruby-value">:undef</span>,<span class="ruby-value">:replace</span>,<span class="ruby-value">:fallback</span>,<span class="ruby-value">:xml</span>,<span class="ruby-value">:cr_newline</span>,<span class="ruby-value">:crlf_newline</span>,<span class="ruby-value">:universal_newline</span>]
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">for</span> <span class="ruby-identifier">the_option_key</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">valid_options</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[(<span class="ruby-identifier">the_option_key</span>)]
|
||||
<span class="ruby-comment"># Note Source: http://ruby-doc.org/core-1.9.3/String.html#method-i-encode</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:fallback</span>
|
||||
<span class="ruby-comment"># Sets the replacement string by the given object for undefined character. The object should be a Hash, a Proc, a Method,</span>
|
||||
<span class="ruby-comment"># or an object which has [] method. Its key is an undefined character encoded in the source encoding of current transcoder.</span>
|
||||
<span class="ruby-comment"># Its value can be any encoding until it can be converted into the destination encoding of the transcoder.</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">new_options</span>[<span class="ruby-value">:replace</span>]
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">options</span>[<span class="ruby-value">:fallback</span>].<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Proc</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Method</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:fallback</span>].<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:[]</span>))
|
||||
<span class="ruby-comment"># if :fallback will not process an Array as mentioned above ... remove :[] respond_to? condition.</span>
|
||||
<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:fallback</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:fallback</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:invalid</span>
|
||||
<span class="ruby-comment"># If the value is :replace, encode replaces invalid byte sequences in str with the replacement character. The default is to</span>
|
||||
<span class="ruby-comment"># raise the Encoding::InvalidByteSequenceError exception</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">new_options</span>[<span class="ruby-value">:fallback</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:invalid</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:replace</span>
|
||||
<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:invalid</span>] = <span class="ruby-value">:replace</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:undef</span>)
|
||||
<span class="ruby-comment"># If the value is :replace, encode replaces characters which are undefined in the destination encoding with the replacement character.</span>
|
||||
<span class="ruby-comment"># The default is to raise the Encoding::UndefinedConversionError.</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">new_options</span>[<span class="ruby-value">:fallback</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:undef</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:replace</span>
|
||||
<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:undef</span>] = <span class="ruby-value">:replace</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:replace</span>)
|
||||
<span class="ruby-comment"># Sets the replacement string to the given value. The default replacement string is “uFFFD” for Unicode encoding forms, and “?” otherwise.</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">new_options</span>[<span class="ruby-value">:fallback</span>]
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:replace</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:replace</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:replace</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:xml</span>
|
||||
<span class="ruby-comment"># The value must be :text or :attr. If the value is :text encode replaces undefined characters with their (upper-case hexadecimal) numeric character</span>
|
||||
<span class="ruby-comment"># references. ‘&’, ‘<’, and ‘>’ are converted to “&amp;”, “&lt;”, and “&gt;”, respectively. If the value is :attr, encode also quotes the replacement</span>
|
||||
<span class="ruby-comment"># result (using ‘“’), and replaces ‘”’ with “&quot;”.</span>
|
||||
<span class="ruby-keyword">if</span> [<span class="ruby-value">:text</span>, <span class="ruby-value">:attr</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:xml</span>])
|
||||
<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:xml</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:xml</span>]
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:cr_newline</span>
|
||||
<span class="ruby-comment"># Replaces LF (“n”) with CR (“r”) if value is true.</span>
|
||||
<span class="ruby-keyword">unless</span> (<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:crlf_newline</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">new_options</span>[<span class="ruby-value">:universal_newline</span>])
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[(<span class="ruby-identifier">the_option_key</span>)] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">new_options</span>[(<span class="ruby-identifier">the_option_key</span>)] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:crlf_newline</span>
|
||||
<span class="ruby-comment"># Replaces LF (“n”) with CRLF (“rn”) if value is true.</span>
|
||||
<span class="ruby-keyword">unless</span> (<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:cr_newline</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">new_options</span>[<span class="ruby-value">:universal_newline</span>])
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[(<span class="ruby-identifier">the_option_key</span>)] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">new_options</span>[(<span class="ruby-identifier">the_option_key</span>)] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_option_key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:universal_newline</span>
|
||||
<span class="ruby-comment"># Replaces CRLF (“rn”) and CR (“r”) with LF (“n”) if value is true.</span>
|
||||
<span class="ruby-keyword">unless</span> (<span class="ruby-identifier">new_options</span>[<span class="ruby-value">:cr_newline</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">new_options</span>[<span class="ruby-value">:crlf_newline</span>])
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[(<span class="ruby-identifier">the_option_key</span>)] <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-identifier">new_options</span>[(<span class="ruby-identifier">the_option_key</span>)] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">pause</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">new_options</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-record_separator_used" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">record_separator_used</span><span
|
||||
class="method-args">(io_channel=:external)</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="record_separator_used-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 188</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">record_separator_used</span>(<span class="ruby-identifier">io_channel</span>=<span class="ruby-value">:external</span>)
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@internal_encoding</span>)
|
||||
<span class="ruby-ivar">@internal_encoding</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@internal_record_separator</span>)
|
||||
<span class="ruby-ivar">@internal_record_separator</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@external_record_separator</span>)
|
||||
<span class="ruby-ivar">@external_record_separator</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">record_separator</span> = <span class="ruby-string">""</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">io_channel</span> <span class="ruby-operator">==</span> <span class="ruby-value">:internal</span>
|
||||
<span class="ruby-identifier">record_separator</span>.<span class="ruby-identifier">force_encoding</span>((<span class="ruby-ivar">@internal_encoding</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>))
|
||||
<span class="ruby-identifier">record_separator</span> <span class="ruby-operator"><<</span> (<span class="ruby-ivar">@internal_record_separator</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">$\</span>).<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">io_channel</span> = <span class="ruby-value">:external</span>
|
||||
<span class="ruby-identifier">record_separator</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>)
|
||||
<span class="ruby-identifier">record_separator</span> <span class="ruby-operator"><<</span> (<span class="ruby-ivar">@external_record_separator</span> <span class="ruby-operator">||</span> (<span class="ruby-identifier">$\</span>).<span class="ruby-identifier">to_s</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">record_separator</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-identifier">record_separator</span>
|
||||
<span class="ruby-keyword">else</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-i-transcode_to_external" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">transcode_to_external</span><span
|
||||
class="method-args">(the_string="")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
<p>TODO: GxG::StringIO : transcoding methods : tie into conversion-options-set-selector supports (dst-encoding,src-encoding). <a href="../../../Hash.html"><code>Hash</code></a> deep-merge method needed.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="transcode_to_external-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 287</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">transcode_to_external</span>(<span class="ruby-identifier">the_string</span>=<span class="ruby-string">""</span>)
|
||||
<span class="ruby-comment"># return the supplied string, or supported object string data, or UTF_8 codepoint, transcoded</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@conversion_options</span>)
|
||||
<span class="ruby-ivar">@conversion_options</span> = {<span class="ruby-value">:internal</span> <span class="ruby-operator">=></span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=></span> {}}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@internal_encoding</span>)
|
||||
<span class="ruby-ivar">@internal_encoding</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-comment"># External conversion options will have to be dynamically generated upon transcode_to_external as *any* encoding is possible, not just internal_encoding</span>
|
||||
<span class="ruby-identifier">the_string</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">convert_to_string</span>(<span class="ruby-identifier">the_string</span>,<span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>,<span class="ruby-ivar">@conversion_options</span>[<span class="ruby-value">:external</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">binmode?</span>()
|
||||
<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">==</span> <span class="ruby-ivar">@internal_encoding</span>
|
||||
<span class="ruby-identifier">options</span> = <span class="ruby-operator">::</span><span class="ruby-constant">String</span><span class="ruby-operator">::</span><span class="ruby-identifier">transcode_options</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>,<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span>,<span class="ruby-ivar">@conversion_options</span>[<span class="ruby-value">:external</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-comment"># External conversion options will have to be dynamically generated upon transcode_to_external as *any* encoding is possible, not just internal_encoding</span>
|
||||
<span class="ruby-identifier">nl_op</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">newline_option_used</span>(<span class="ruby-value">:external</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">nl_op</span>
|
||||
<span class="ruby-identifier">options</span>[(<span class="ruby-identifier">nl_op</span>)] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">options</span> = <span class="ruby-operator">::</span><span class="ruby-constant">String</span><span class="ruby-operator">::</span><span class="ruby-identifier">transcode_options</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>,<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">transcode!</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">the_string</span>
|
||||
<span class="ruby-keyword">end</span></pre>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method-i-transcode_to_internal" class="method-detail ">
|
||||
|
||||
<div class="method-heading">
|
||||
<span class="method-name">transcode_to_internal</span><span
|
||||
class="method-args">(the_string="")</span>
|
||||
|
||||
<span class="method-click-advice">click to toggle source</span>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="method-source-code" id="transcode_to_internal-source">
|
||||
<pre><span class="ruby-comment"># File lib/gxg/gxg_transcode.rb, line 324</span>
|
||||
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">transcode_to_internal</span>(<span class="ruby-identifier">the_string</span>=<span class="ruby-string">""</span>)
|
||||
<span class="ruby-comment"># return the supplied string, or supported object string data, or UTF_8 codepoint, transcoded</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@conversion_options</span>)
|
||||
<span class="ruby-ivar">@conversion_options</span> = {<span class="ruby-value">:internal</span> <span class="ruby-operator">=></span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=></span> {}}
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_defined?</span>(<span class="ruby-value">:@internal_encoding</span>)
|
||||
<span class="ruby-ivar">@internal_encoding</span> = <span class="ruby-keyword">nil</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@internal_encoding</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">binmode?</span>())
|
||||
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
||||
<span class="ruby-identifier">the_string</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">convert_to_string</span>(<span class="ruby-identifier">the_string</span>,<span class="ruby-ivar">@internal_encoding</span>,<span class="ruby-ivar">@conversion_options</span>[<span class="ruby-value">:internal</span>])
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@internal_encoding</span> <span class="ruby-operator">==</span> <span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>
|
||||
<span class="ruby-comment"># for cases where the external encoding is anything but binary, but the internal is set to BINARY.</span>
|
||||
<span class="ruby-comment"># instead of actually transcoding something char by char into binary - just sets the encoding and filters for newline settings.</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>)
|
||||
<span class="ruby-identifier">nl_op</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">newline_option_used</span>(<span class="ruby-value">:internal</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">nl_op</span>
|
||||
<span class="ruby-identifier">options</span>[(<span class="ruby-identifier">nl_op</span>)] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">the_string</span> = <span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>,<span class="ruby-operator">::</span><span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">ASCII_8BIT</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">!=</span> <span class="ruby-ivar">@internal_encoding</span>)
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">external_encoding</span>
|
||||
<span class="ruby-identifier">options</span> = <span class="ruby-operator">::</span><span class="ruby-constant">String</span><span class="ruby-operator">::</span><span class="ruby-identifier">transcode_options</span>(<span class="ruby-ivar">@internal_encoding</span>,<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span>,<span class="ruby-ivar">@conversion_options</span>[<span class="ruby-value">:internal</span>])
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">nl_op</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">newline_option_used</span>(<span class="ruby-value">:internal</span>)
|
||||
<span class="ruby-identifier">options</span> = {}
|
||||
<span class="ruby-keyword">if</span> <span class="ruby-identifier">nl_op</span>
|
||||
<span class="ruby-identifier">options</span>[(<span class="ruby-identifier">nl_op</span>)] = <span class="ruby-keyword">true</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">options</span> = <span class="ruby-operator">::</span><span class="ruby-constant">String</span><span class="ruby-operator">::</span><span class="ruby-identifier">transcode_options</span>(<span class="ruby-ivar">@internal_encoding</span>,<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">encoding</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-identifier">the_string</span>.<span class="ruby-identifier">transcode!</span>(<span class="ruby-ivar">@internal_encoding</span>,<span class="ruby-identifier">options</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-keyword">else</span>
|
||||
<span class="ruby-identifier">the_string</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">transcode_to_external</span>(<span class="ruby-identifier">the_string</span>)
|
||||
<span class="ruby-keyword">end</span>
|
||||
<span class="ruby-comment">#</span>
|
||||
<span class="ruby-identifier">the_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.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>
|
||||
|
||||
2346
doc/GxG/Support/Library/TranscodingIO.html
Normal file
2346
doc/GxG/Support/Library/TranscodingIO.html
Normal file
File diff suppressed because it is too large
Load diff
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue