1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
|
<!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><span class="include">Enumerable</span>
</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-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-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 IO#sync 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 lib/openssl/buffering.rb, line 63</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-constant">Buffer</span>.<span class="ruby-identifier">new</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 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>
<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 lib/openssl/buffering.rb, line 474</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 lib/openssl/buffering.rb, line 250</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 lib/openssl/buffering.rb, line 291</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 lib/openssl/buffering.rb, line 322</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 lib/openssl/buffering.rb, line 462</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 lib/openssl/buffering.rb, line 284</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 String or Regexp.</p>
<p>Unlike IO#gets the line read will not be assigned to +$_+.</p>
<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>
<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 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>
<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> }
<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 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>
<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 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>
<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>
<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 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>
<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 EOFError.</p>
<div class="method-source-code" id="read_nonblock-source">
<pre><span class="ruby-comment"># File lib/openssl/buffering.rb, line 195</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 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>
<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 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>
<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 lib/openssl/buffering.rb, line 262</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 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>
<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 IO#getc 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 lib/openssl/buffering.rb, line 314</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 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>
<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 lib/openssl/buffering.rb, line 404</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>
</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.3.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
