Initial Commit

This commit is contained in:
G. Gibson 2021-11-16 08:41:53 -08:00
commit 4bb9f2f2ea
189 changed files with 135079 additions and 2 deletions

View 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>

View 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">&quot;you MUST specify an Array of :mode flags (as symbols)&quot;</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">&lt;&lt;</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">=&gt;</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">&lt;&lt;</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">&lt;&lt;</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">&quot;you specify :mode as: 2nd parameter (String || Numeric) or an option in 3rd parameter Hash, but not in both&quot;</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">&quot;:&quot;</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">&gt;</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">&gt;</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">&quot;you MUST specify an IO :object or a :file_descriptor Fixnum&quot;</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">&amp;</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">&lt;&lt;</span> <span class="ruby-value">:read</span>
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</span> <span class="ruby-value">:read</span>
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&amp;</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">&lt;&lt;</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">&quot;b&quot;</span>)
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&lt;&lt;</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">&quot;r&quot;</span>)
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&quot;+&quot;</span>)
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&quot;w&quot;</span>)
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value">:write</span>
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&quot;+&quot;</span>)
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&quot;a&quot;</span>)
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value">:write</span>
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&quot;+&quot;</span>)
<span class="ruby-identifier">raw_params</span>[<span class="ruby-value">:mode</span>] <span class="ruby-operator">&lt;&lt;</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">&quot;:external_encoding :#{raw_params[:external_encoding].to_s} unsupported&quot;</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">&quot;:internal_encoding :#{raw_params[:internal_encoding].to_s} unsupported&quot;</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>

View 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">&quot;you MUST specify an IO :object or a :file_descriptor Fixnum&quot;</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>

View 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">&amp;</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">&quot;attempting to recv on a closed stream&quot;</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">&quot;&quot;</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">&quot;abc&quot;</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">&lt;</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">&gt;</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">result</span> <span class="ruby-operator">&lt;&lt;</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">&quot;attempting to recv on a closed stream&quot;</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">&amp;</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">&quot;attempting to recvmsg on a closed stream&quot;</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">&quot;attempting to recvmsg on a closed stream&quot;</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=&quot;&quot;, 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">&quot;&quot;</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">=&gt;</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:last</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:high</span> <span class="ruby-operator">=&gt;</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">&quot;attempting to send on a closed stream&quot;</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">&gt;</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">&gt;</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">&gt;=</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">&gt;</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=&quot;&quot;, 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">&quot;&quot;</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">=&gt;</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:last</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-keyword">nil</span>, <span class="ruby-value">:high</span> <span class="ruby-operator">=&gt;</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">&amp;</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">&quot;attempting to sendmsg on a closed stream&quot;</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">&gt;</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">&quot;you MUST supply ancillary data as a control&quot;</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">&gt;=</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">&gt;</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">&quot;attempting to sendmsg on a closed stream&quot;</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">&gt;</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">&quot;you MUST supply ancillary data as a control&quot;</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">&gt;=</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">&gt;</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>

View 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">&amp;</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">&quot;attempting to recvmsg on a closed stream&quot;</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">&quot;attempting to recvmsg on a closed stream&quot;</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>

File diff suppressed because it is too large Load diff

View 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">&quot;you MUST specify a String&quot;</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">&quot;&quot;</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>

View 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">&quot;&quot;</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">&quot;&quot;</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">&gt;=</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">data</span> = <span class="ruby-string">&quot;&quot;</span>
<span class="ruby-keyword">if</span> (<span class="ruby-value">0xFFFFFFFF</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">to_i</span>) <span class="ruby-operator">&gt;</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">&lt;&lt;</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">&gt;</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">&amp;&amp;</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">&lt;&lt;</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">&lt;&lt;</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">&lt;&lt;</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">&quot;&quot;</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">&lt;&lt;</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">&lt;&lt;</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">&gt;</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">=&gt;</span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=&gt;</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">=&gt;</span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=&gt;</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">&quot;&quot;</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">&lt;&lt;</span> <span class="ruby-string">&quot;\r&quot;</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">&lt;&lt;</span> <span class="ruby-string">&quot;\r\n&quot;</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">&lt;&lt;</span> <span class="ruby-string">&quot;\n&quot;</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">&lt;&lt;</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">&quot;You must pass conversion options parameter as a Hash&quot;</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. ‘&amp;’, ‘&lt;’, and ‘&gt;’ are converted to “&amp;amp;”, “&amp;lt;”, and “&amp;gt;”, respectively. If the value is :attr, encode also quotes the replacement</span>
<span class="ruby-comment"># result (using ‘“’), and replaces ‘”’ with “&amp;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">&quot;&quot;</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">&lt;&lt;</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">&lt;&lt;</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">&gt;</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=&quot;&quot;)</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">&quot;&quot;</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">=&gt;</span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=&gt;</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">&gt;</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=&quot;&quot;)</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">&quot;&quot;</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">=&gt;</span> {}, <span class="ruby-value">:external</span> <span class="ruby-operator">=&gt;</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">&amp;&amp;</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">&gt;</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>

File diff suppressed because it is too large Load diff