File: C:/Ruby27-x64/share/doc/ruby/html/OpenSSL/Buffering.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module OpenSSL::Buffering - 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 id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Enumerable.html">Enumerable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3C-3C">#<<</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-consume_rbuff">#consume_rbuff</a>
<li ><a href="#method-i-do_write">#do_write</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-each_byte">#each_byte</a>
<li ><a href="#method-i-each_line">#each_line</a>
<li ><a href="#method-i-eof">#eof</a>
<li ><a href="#method-i-eof-3F">#eof?</a>
<li ><a href="#method-i-fill_rbuff">#fill_rbuff</a>
<li ><a href="#method-i-flush">#flush</a>
<li ><a href="#method-i-getc">#getc</a>
<li ><a href="#method-i-gets">#gets</a>
<li ><a href="#method-i-print">#print</a>
<li ><a href="#method-i-printf">#printf</a>
<li ><a href="#method-i-puts">#puts</a>
<li ><a href="#method-i-read">#read</a>
<li ><a href="#method-i-read_nonblock">#read_nonblock</a>
<li ><a href="#method-i-readchar">#readchar</a>
<li ><a href="#method-i-readline">#readline</a>
<li ><a href="#method-i-readlines">#readlines</a>
<li ><a href="#method-i-readpartial">#readpartial</a>
<li ><a href="#method-i-ungetc">#ungetc</a>
<li ><a href="#method-i-write">#write</a>
<li ><a href="#method-i-write_nonblock">#write_nonblock</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-OpenSSL::Buffering">
<h1 id="module-OpenSSL::Buffering" class="module">
module OpenSSL::Buffering
</h1>
<section class="description">
<p><a href="../OpenSSL.html"><code>OpenSSL</code></a> <a href="../IO.html"><code>IO</code></a> buffering mix-in module.</p>
<p>This module allows an <a href="SSL/SSLSocket.html"><code>OpenSSL::SSL::SSLSocket</code></a> to behave like an <a href="../IO.html"><code>IO</code></a>.</p>
<p>You typically won't use this module directly, you can see it implemented in <a href="SSL/SSLSocket.html"><code>OpenSSL::SSL::SSLSocket</code></a>.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="BLOCK_SIZE">BLOCK_SIZE
<dd><p>Default size to read from or write to the SSLSocket for buffer operations.</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-sync" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">sync</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The “sync mode” of the SSLSocket.</p>
<p>See <a href="../IO.html#method-i-sync"><code>IO#sync</code></a> for full details.</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(*)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates an instance of OpenSSL's buffering <a href="../IO.html"><code>IO</code></a> module.</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 40</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-operator">*</span>)
<span class="ruby-keyword">super</span>
<span class="ruby-ivar">@eof</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@rbuffer</span> = <span class="ruby-string">""</span>
<span class="ruby-ivar">@sync</span> = <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">sync</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-3C-3C" class="method-detail ">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Writes <em>s</em> to the stream. <em>s</em> will be converted to a <a href="../String.html"><code>String</code></a> using <code>.to_s</code> method.</p>
<div class="method-source-code" id="3C-3C-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 390</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title"><<</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-identifier">do_write</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Closes the SSLSocket and flushes any unwritten data.</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 451</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-identifier">flush</span> <span class="ruby-keyword">rescue</span> <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">sysclose</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">(eol=$/) { |line| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Executes the block for every line in the stream where lines are separated by <em>eol</em>.</p>
<p>See also <a href="Buffering.html#method-i-gets"><code>gets</code></a></p>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 227</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>)
<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">gets</span>(<span class="ruby-identifier">eol</span>)
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Buffering.html#method-i-each_line">each_line</a>
</div>
</div>
<div id="method-i-each_byte" class="method-detail ">
<div class="method-heading">
<span class="method-name">each_byte</span><span
class="method-args">() { |byte| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calls the given block once for each byte in the stream.</p>
<div class="method-source-code" id="each_byte-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 268</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each_byte</span> <span class="ruby-comment"># :yields: byte</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">c</span> = <span class="ruby-identifier">getc</span>
<span class="ruby-keyword">yield</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">ord</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each_line" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">each_line</span><span
class="method-args">(eol=$/)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Buffering.html#method-i-each">each</a>
</div>
</div>
<div id="method-i-eof" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">eof</span><span
class="method-args">()</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Buffering.html#method-i-eof-3F">eof?</a>
</div>
</div>
<div id="method-i-eof-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">eof?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if the stream is at file which means there is no more data to be read.</p>
<div class="method-source-code" id="eof-3F-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 299</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">eof?</span>
<span class="ruby-identifier">fill_rbuff</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@eof</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@eof</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Buffering.html#method-i-eof">eof</a>
</div>
</div>
<div id="method-i-flush" class="method-detail ">
<div class="method-heading">
<span class="method-name">flush</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Flushes buffered data to the SSLSocket.</p>
<div class="method-source-code" id="flush-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 439</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">flush</span>
<span class="ruby-identifier">osync</span> = <span class="ruby-ivar">@sync</span>
<span class="ruby-ivar">@sync</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">do_write</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-ivar">@sync</span> = <span class="ruby-identifier">osync</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-getc" class="method-detail ">
<div class="method-heading">
<span class="method-name">getc</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads one character from the stream. Returns nil if called at end of file.</p>
<div class="method-source-code" id="getc-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 261</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getc</span>
<span class="ruby-identifier">read</span>(<span class="ruby-value">1</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gets" class="method-detail ">
<div class="method-heading">
<span class="method-name">gets</span><span
class="method-args">(eol=$/, limit=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads the next “line” from the stream. Lines are separated by <em>eol</em>. If <em>limit</em> is provided the result will not be longer than the given number of bytes.</p>
<p><em>eol</em> may be a <a href="../String.html"><code>String</code></a> or <a href="../Regexp.html"><code>Regexp</code></a>.</p>
<p>Unlike <a href="../IO.html#method-i-gets"><code>IO#gets</code></a> the line read will not be assigned to +$_+.</p>
<p>Unlike <a href="../IO.html#method-i-gets"><code>IO#gets</code></a> the separator must be provided if a limit is provided.</p>
<div class="method-source-code" id="gets-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gets</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>, <span class="ruby-identifier">limit</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">idx</span> = <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">eol</span>)
<span class="ruby-keyword">until</span> <span class="ruby-ivar">@eof</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">idx</span>
<span class="ruby-identifier">fill_rbuff</span>
<span class="ruby-identifier">idx</span> = <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">index</span>(<span class="ruby-identifier">eol</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">eol</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Regexp</span>)
<span class="ruby-identifier">size</span> = <span class="ruby-identifier">idx</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">idx</span><span class="ruby-operator">+</span><span class="ruby-node">$&</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">size</span> = <span class="ruby-identifier">idx</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">idx</span><span class="ruby-operator">+</span><span class="ruby-identifier">eol</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">>=</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">size</span> = [<span class="ruby-identifier">size</span>, <span class="ruby-identifier">limit</span>].<span class="ruby-identifier">min</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">consume_rbuff</span>(<span class="ruby-identifier">size</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-print" class="method-detail ">
<div class="method-heading">
<span class="method-name">print</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Writes <em>args</em> to the stream.</p>
<p>See <a href="../IO.html#method-i-print"><code>IO#print</code></a> for full details.</p>
<div class="method-source-code" id="print-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 418</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">s</span> = <span class="ruby-string">""</span>
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">each</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_s</span> }
<span class="ruby-identifier">do_write</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-printf" class="method-detail ">
<div class="method-heading">
<span class="method-name">printf</span><span
class="method-args">(s, *args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Formats and writes to the stream converting parameters under control of the format string.</p>
<p>See <a href="../Kernel.html#method-i-sprintf"><code>Kernel#sprintf</code></a> for format string details.</p>
<div class="method-source-code" id="printf-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 431</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">printf</span>(<span class="ruby-identifier">s</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">do_write</span>(<span class="ruby-identifier">s</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">args</span>)
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-puts" class="method-detail ">
<div class="method-heading">
<span class="method-name">puts</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Writes <em>args</em> to the stream along with a record separator.</p>
<p>See <a href="../IO.html#method-i-puts"><code>IO#puts</code></a> for full details.</p>
<div class="method-source-code" id="puts-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 400</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-identifier">s</span> = <span class="ruby-string">""</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-identifier">s</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">s</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp">/(?<!\n)\z/</span>, <span class="ruby-string">"\n"</span>)
}
<span class="ruby-identifier">do_write</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-read" class="method-detail ">
<div class="method-heading">
<span class="method-name">read</span><span
class="method-args">(size=nil, buf=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads <em>size</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will receive the data.</p>
<p>See <a href="../IO.html#method-i-read"><code>IO#read</code></a> for full details.</p>
<div class="method-source-code" id="read-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read</span>(<span class="ruby-identifier">size</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">buf</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buf</span>
<span class="ruby-identifier">buf</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">buf</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">until</span> <span class="ruby-ivar">@eof</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">size</span> <span class="ruby-operator"><=</span> <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">size</span>
<span class="ruby-identifier">fill_rbuff</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ret</span> = <span class="ruby-identifier">consume_rbuff</span>(<span class="ruby-identifier">size</span>) <span class="ruby-operator">||</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buf</span>
<span class="ruby-identifier">buf</span>.<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">ret</span>)
<span class="ruby-identifier">ret</span> = <span class="ruby-identifier">buf</span>
<span class="ruby-keyword">end</span>
(<span class="ruby-identifier">size</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">ret</span>.<span class="ruby-identifier">empty?</span>) <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-read_nonblock" class="method-detail ">
<div class="method-heading">
<span class="method-name">read_nonblock</span><span
class="method-args">(maxlen, buf=nil, exception: true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads at most <em>maxlen</em> bytes in the non-blocking manner.</p>
<p>When no data can be read without blocking it raises <a href="SSL/SSLError.html"><code>OpenSSL::SSL::SSLError</code></a> extended by <a href="../IO/WaitReadable.html"><code>IO::WaitReadable</code></a> or <a href="../IO/WaitWritable.html"><code>IO::WaitWritable</code></a>.</p>
<p><a href="../IO/WaitReadable.html"><code>IO::WaitReadable</code></a> means <a href="SSL.html"><code>SSL</code></a> needs to read internally so <a href="Buffering.html#method-i-read_nonblock"><code>read_nonblock</code></a> should be called again when the underlying <a href="../IO.html"><code>IO</code></a> is readable.</p>
<p><a href="../IO/WaitWritable.html"><code>IO::WaitWritable</code></a> means <a href="SSL.html"><code>SSL</code></a> needs to write internally so <a href="Buffering.html#method-i-read_nonblock"><code>read_nonblock</code></a> should be called again after the underlying <a href="../IO.html"><code>IO</code></a> is writable.</p>
<p><a href="Buffering.html#method-i-read_nonblock"><code>OpenSSL::Buffering#read_nonblock</code></a> needs two rescue clause as follows:</p>
<pre class="ruby"><span class="ruby-comment"># emulates blocking read (readpartial).</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">ssl</span>.<span class="ruby-identifier">read_nonblock</span>(<span class="ruby-identifier">maxlen</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>
<span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span>([<span class="ruby-identifier">io</span>])
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>
<span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span>(<span class="ruby-keyword">nil</span>, [<span class="ruby-identifier">io</span>])
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Note that one reason that <a href="Buffering.html#method-i-read_nonblock"><code>read_nonblock</code></a> writes to the underlying <a href="../IO.html"><code>IO</code></a> is when the peer requests a new TLS/SSL handshake. See openssl the FAQ for more details. <a href="http://www.openssl.org/support/faq.html">www.openssl.org/support/faq.html</a></p>
<p>By specifying a keyword argument <em>exception</em> to <code>false</code>, you can indicate that <a href="Buffering.html#method-i-read_nonblock"><code>read_nonblock</code></a> should not raise an IO::Wait*able exception, but return the symbol <code>:wait_writable</code> or <code>:wait_readable</code> instead. At EOF, it will return <code>nil</code> instead of raising <a href="../EOFError.html"><code>EOFError</code></a>.</p>
<div class="method-source-code" id="read_nonblock-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 172</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">read_nonblock</span>(<span class="ruby-identifier">maxlen</span>, <span class="ruby-identifier">buf</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-value">exception:</span> <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">maxlen</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buf</span>
<span class="ruby-identifier">buf</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">buf</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">sysread_nonblock</span>(<span class="ruby-identifier">maxlen</span>, <span class="ruby-identifier">buf</span>, <span class="ruby-value">exception:</span> <span class="ruby-identifier">exception</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ret</span> = <span class="ruby-identifier">consume_rbuff</span>(<span class="ruby-identifier">maxlen</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buf</span>
<span class="ruby-identifier">buf</span>.<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">ret</span>)
<span class="ruby-identifier">ret</span> = <span class="ruby-identifier">buf</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-readchar" class="method-detail ">
<div class="method-heading">
<span class="method-name">readchar</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads a one-character string from the stream. Raises an <a href="../EOFError.html"><code>EOFError</code></a> at end of file.</p>
<div class="method-source-code" id="readchar-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 278</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readchar</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">EOFError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">eof?</span>
<span class="ruby-identifier">getc</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-readline" class="method-detail ">
<div class="method-heading">
<span class="method-name">readline</span><span
class="method-args">(eol=$/)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads a line from the stream which is separated by <em>eol</em>.</p>
<p>Raises <a href="../EOFError.html"><code>EOFError</code></a> if at end of file.</p>
<div class="method-source-code" id="readline-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 252</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readline</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">EOFError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">eof?</span>
<span class="ruby-identifier">gets</span>(<span class="ruby-identifier">eol</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-readlines" class="method-detail ">
<div class="method-heading">
<span class="method-name">readlines</span><span
class="method-args">(eol=$/)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads lines from the stream which are separated by <em>eol</em>.</p>
<p>See also <a href="Buffering.html#method-i-gets"><code>gets</code></a></p>
<div class="method-source-code" id="readlines-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 239</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readlines</span>(<span class="ruby-identifier">eol</span>=<span class="ruby-identifier">$/</span>)
<span class="ruby-identifier">ary</span> = []
<span class="ruby-keyword">while</span> <span class="ruby-identifier">line</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">gets</span>(<span class="ruby-identifier">eol</span>)
<span class="ruby-identifier">ary</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">line</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ary</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-readpartial" class="method-detail ">
<div class="method-heading">
<span class="method-name">readpartial</span><span
class="method-args">(maxlen, buf=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Reads at most <em>maxlen</em> bytes from the stream. If <em>buf</em> is provided it must reference a string which will receive the data.</p>
<p>See <a href="../IO.html#method-i-readpartial"><code>IO#readpartial</code></a> for full details.</p>
<div class="method-source-code" id="readpartial-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 114</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readpartial</span>(<span class="ruby-identifier">maxlen</span>, <span class="ruby-identifier">buf</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">maxlen</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buf</span>
<span class="ruby-identifier">buf</span>.<span class="ruby-identifier">clear</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">buf</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">sysread</span>(<span class="ruby-identifier">maxlen</span>, <span class="ruby-identifier">buf</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EAGAIN</span>
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ret</span> = <span class="ruby-identifier">consume_rbuff</span>(<span class="ruby-identifier">maxlen</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">buf</span>
<span class="ruby-identifier">buf</span>.<span class="ruby-identifier">replace</span>(<span class="ruby-identifier">ret</span>)
<span class="ruby-identifier">ret</span> = <span class="ruby-identifier">buf</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ungetc" class="method-detail ">
<div class="method-heading">
<span class="method-name">ungetc</span><span
class="method-args">(c)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Pushes character <em>c</em> back onto the stream such that a subsequent buffered character read will return it.</p>
<p>Unlike <a href="../IO.html#method-i-getc"><code>IO#getc</code></a> multiple bytes may be pushed back onto the stream.</p>
<p>Has no effect on unbuffered reads (such as sysread).</p>
<div class="method-source-code" id="ungetc-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 291</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ungetc</span>(<span class="ruby-identifier">c</span>)
<span class="ruby-ivar">@rbuffer</span>[<span class="ruby-value">0</span>,<span class="ruby-value">0</span>] = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">chr</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">(*s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Writes <em>s</em> to the stream. If the argument is not a <a href="../String.html"><code>String</code></a> it will be converted using <code>.to_s</code> method. Returns the number of bytes written.</p>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 337</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">s</span>)
<span class="ruby-identifier">s</span>.<span class="ruby-identifier">inject</span>(<span class="ruby-value">0</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">written</span>, <span class="ruby-identifier">str</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">do_write</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-identifier">written</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">bytesize</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_nonblock" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_nonblock</span><span
class="method-args">(s, exception: true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Writes <em>s</em> in the non-blocking manner.</p>
<p>If there is buffered data, it is flushed first. This may block.</p>
<p><a href="Buffering.html#method-i-write_nonblock"><code>write_nonblock</code></a> returns number of bytes written to the <a href="SSL.html"><code>SSL</code></a> connection.</p>
<p>When no data can be written without blocking it raises <a href="SSL/SSLError.html"><code>OpenSSL::SSL::SSLError</code></a> extended by <a href="../IO/WaitReadable.html"><code>IO::WaitReadable</code></a> or <a href="../IO/WaitWritable.html"><code>IO::WaitWritable</code></a>.</p>
<p><a href="../IO/WaitReadable.html"><code>IO::WaitReadable</code></a> means <a href="SSL.html"><code>SSL</code></a> needs to read internally so <a href="Buffering.html#method-i-write_nonblock"><code>write_nonblock</code></a> should be called again after the underlying <a href="../IO.html"><code>IO</code></a> is readable.</p>
<p><a href="../IO/WaitWritable.html"><code>IO::WaitWritable</code></a> means <a href="SSL.html"><code>SSL</code></a> needs to write internally so <a href="Buffering.html#method-i-write_nonblock"><code>write_nonblock</code></a> should be called again after underlying <a href="../IO.html"><code>IO</code></a> is writable.</p>
<p>So <a href="Buffering.html#method-i-write_nonblock"><code>OpenSSL::Buffering#write_nonblock</code></a> needs two rescue clause as follows.</p>
<pre class="ruby"><span class="ruby-comment"># emulates blocking write.</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">ssl</span>.<span class="ruby-identifier">write_nonblock</span>(<span class="ruby-identifier">str</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitReadable</span>
<span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span>([<span class="ruby-identifier">io</span>])
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">IO</span><span class="ruby-operator">::</span><span class="ruby-constant">WaitWritable</span>
<span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span>(<span class="ruby-keyword">nil</span>, [<span class="ruby-identifier">io</span>])
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Note that one reason that <a href="Buffering.html#method-i-write_nonblock"><code>write_nonblock</code></a> reads from the underlying <a href="../IO.html"><code>IO</code></a> is when the peer requests a new TLS/SSL handshake. See the openssl FAQ for more details. <a href="http://www.openssl.org/support/faq.html">www.openssl.org/support/faq.html</a></p>
<p>By specifying a keyword argument <em>exception</em> to <code>false</code>, you can indicate that <a href="Buffering.html#method-i-write_nonblock"><code>write_nonblock</code></a> should not raise an IO::Wait*able exception, but return the symbol <code>:wait_writable</code> or <code>:wait_readable</code> instead.</p>
<div class="method-source-code" id="write_nonblock-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 381</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_nonblock</span>(<span class="ruby-identifier">s</span>, <span class="ruby-value">exception:</span> <span class="ruby-keyword">true</span>)
<span class="ruby-identifier">flush</span>
<span class="ruby-identifier">syswrite_nonblock</span>(<span class="ruby-identifier">s</span>, <span class="ruby-value">exception:</span> <span class="ruby-identifier">exception</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-consume_rbuff" class="method-detail ">
<div class="method-heading">
<span class="method-name">consume_rbuff</span><span
class="method-args">(size=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Consumes <em>size</em> bytes from the buffer</p>
<div class="method-source-code" id="consume_rbuff-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 68</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">consume_rbuff</span>(<span class="ruby-identifier">size</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">size</span> = <span class="ruby-ivar">@rbuffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">size</span>
<span class="ruby-identifier">ret</span> = <span class="ruby-ivar">@rbuffer</span>[<span class="ruby-value">0</span>, <span class="ruby-identifier">size</span>]
<span class="ruby-ivar">@rbuffer</span>[<span class="ruby-value">0</span>, <span class="ruby-identifier">size</span>] = <span class="ruby-string">""</span>
<span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_write" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_write</span><span
class="method-args">(s)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Writes <em>s</em> to the buffer. When the buffer is full or <a href="Buffering.html#attribute-i-sync"><code>sync</code></a> is true the buffer is flushed to the underlying socket.</p>
<div class="method-source-code" id="do_write-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 314</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_write</span>(<span class="ruby-identifier">s</span>)
<span class="ruby-ivar">@wbuffer</span> = <span class="ruby-string">""</span> <span class="ruby-keyword">unless</span> <span class="ruby-keyword">defined?</span> <span class="ruby-ivar">@wbuffer</span>
<span class="ruby-ivar">@wbuffer</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">s</span>
<span class="ruby-ivar">@wbuffer</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">BINARY</span>)
<span class="ruby-ivar">@sync</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@sync</span> <span class="ruby-keyword">or</span> <span class="ruby-ivar">@wbuffer</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-constant">BLOCK_SIZE</span>
<span class="ruby-keyword">until</span> <span class="ruby-ivar">@wbuffer</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">nwrote</span> = <span class="ruby-identifier">syswrite</span>(<span class="ruby-ivar">@wbuffer</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EAGAIN</span>
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@wbuffer</span>[<span class="ruby-value">0</span>, <span class="ruby-identifier">nwrote</span>] = <span class="ruby-string">""</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-fill_rbuff" class="method-detail ">
<div class="method-heading">
<span class="method-name">fill_rbuff</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fills the buffer from the underlying SSLSocket</p>
<div class="method-source-code" id="fill_rbuff-source">
<pre><span class="ruby-comment"># File ext/openssl/lib/openssl/buffering.rb, line 55</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fill_rbuff</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-ivar">@rbuffer</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">sysread</span>(<span class="ruby-constant">BLOCK_SIZE</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EAGAIN</span>
<span class="ruby-keyword">retry</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">EOFError</span>
<span class="ruby-ivar">@eof</span> = <span class="ruby-keyword">true</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.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>