diff options
Diffstat (limited to 'OpenSSL/Buffering.html')
| -rw-r--r-- | OpenSSL/Buffering.html | 64 |
1 files changed, 44 insertions, 20 deletions
diff --git a/OpenSSL/Buffering.html b/OpenSSL/Buffering.html index abaa0cfa..8aa3de5d 100644 --- a/OpenSSL/Buffering.html +++ b/OpenSSL/Buffering.html @@ -83,6 +83,7 @@ <li ><a href="#method-i-eof">#eof</a> <li ><a href="#method-i-eof-3F">#eof?</a> <li ><a href="#method-i-flush">#flush</a> + <li ><a href="#method-i-getbyte">#getbyte</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> @@ -202,7 +203,7 @@ <p>Writes <em>s</em> to the stream. <em>s</em> will be converted to a String using <code>.to_s</code> method.</p> <div class="method-source-code" id="3C-3C-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 413</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 422</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> @@ -224,7 +225,7 @@ <p>Closes the SSLSocket and flushes any unwritten data.</p> <div class="method-source-code" id="close-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 474</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 483</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> @@ -248,7 +249,7 @@ <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 lib/openssl/buffering.rb, line 250</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 259</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> @@ -274,7 +275,7 @@ <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 lib/openssl/buffering.rb, line 291</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 300</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>) @@ -331,7 +332,7 @@ <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 lib/openssl/buffering.rb, line 322</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 331</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> @@ -356,7 +357,7 @@ <p>Flushes buffered data to the SSLSocket.</p> <div class="method-source-code" id="flush-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 462</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 471</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> @@ -371,6 +372,29 @@ </div> + <div id="method-i-getbyte" class="method-detail "> + <div class="method-heading"> + <span class="method-callseq"> + getbyte → 81 + </span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + <p>Get the next 8bit byte from ‘ssl`. Returns `nil` on EOF</p> + + <div class="method-source-code" id="getbyte-source"> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 108</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">getbyte</span> + <span class="ruby-identifier">byte</span> = <span class="ruby-identifier">read</span>(<span class="ruby-value">1</span>) + <span class="ruby-identifier">byte</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">byte</span>.<span class="ruby-identifier">unpack1</span>(<span class="ruby-string">"C"</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 @@ -382,7 +406,7 @@ <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 lib/openssl/buffering.rb, line 284</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 293</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> @@ -409,7 +433,7 @@ <p>Unlike IO#gets 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 lib/openssl/buffering.rb, line 226</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 235</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> @@ -446,7 +470,7 @@ <p>See IO#print for full details.</p> <div class="method-source-code" id="print-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 441</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 450</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-constant">Buffer</span>.<span class="ruby-identifier">new</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> } @@ -472,7 +496,7 @@ <p>See Kernel#sprintf for format string details.</p> <div class="method-source-code" id="printf-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 454</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 463</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> @@ -496,7 +520,7 @@ <p>See IO#puts for full details.</p> <div class="method-source-code" id="puts-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 423</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 432</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-constant">Buffer</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span> @@ -528,7 +552,7 @@ <p>See IO#read for full details.</p> <div class="method-source-code" id="read-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 110</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 119</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> @@ -590,7 +614,7 @@ <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 EOFError.</p> <div class="method-source-code" id="read_nonblock-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 195</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 204</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> @@ -627,7 +651,7 @@ <p>Reads a one-character string from the stream. Raises an EOFError at end of file.</p> <div class="method-source-code" id="readchar-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 301</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 310</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> @@ -651,7 +675,7 @@ <p>Raises EOFError if at end of file.</p> <div class="method-source-code" id="readline-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 275</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 284</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>) @@ -675,7 +699,7 @@ <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 lib/openssl/buffering.rb, line 262</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 271</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>) @@ -702,7 +726,7 @@ <p>See IO#readpartial for full details.</p> <div class="method-source-code" id="readpartial-source"> - <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 137</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 146</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> @@ -747,7 +771,7 @@ <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 lib/openssl/buffering.rb, line 314</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 323</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> @@ -768,7 +792,7 @@ <p>Writes <em>s</em> to the stream. If the argument is not a String 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 lib/openssl/buffering.rb, line 360</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 369</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>) @@ -820,7 +844,7 @@ <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 lib/openssl/buffering.rb, line 404</span> + <pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 413</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>) |