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
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
|
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Net::SSH::Connection::Channel - net-ssh 6.0.0.beta1</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../../";
var index_rel_prefix = "../../../";
</script>
<script src="../../../js/jquery.js"></script>
<script src="../../../js/darkfish.js"></script>
<link href="../../../css/fonts.css" rel="stylesheet">
<link href="../../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../../table_of_contents.html#pages">Pages</a>
<a href="../../../table_of_contents.html#classes">Classes</a>
<a href="../../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">Object
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Loggable.html">Net::SSH::Loggable</a>
<li><a class="include" href="Constants.html">Net::SSH::Connection::Constants</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-5B-5D-3D">#[]=</a>
<li ><a href="#method-i-active-3F">#active?</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-closing-3F">#closing?</a>
<li ><a href="#method-i-do_close">#do_close</a>
<li ><a href="#method-i-do_eof">#do_eof</a>
<li ><a href="#method-i-do_extended_data">#do_extended_data</a>
<li ><a href="#method-i-do_failure">#do_failure</a>
<li ><a href="#method-i-do_open_failed">#do_open_failed</a>
<li ><a href="#method-i-do_success">#do_success</a>
<li ><a href="#method-i-env">#env</a>
<li ><a href="#method-i-eof-21">#eof!</a>
<li ><a href="#method-i-eof-3F">#eof?</a>
<li ><a href="#method-i-exec">#exec</a>
<li ><a href="#method-i-local_closed-3F">#local_closed?</a>
<li ><a href="#method-i-on_close">#on_close</a>
<li ><a href="#method-i-on_data">#on_data</a>
<li ><a href="#method-i-on_eof">#on_eof</a>
<li ><a href="#method-i-on_extended_data">#on_extended_data</a>
<li ><a href="#method-i-on_open_failed">#on_open_failed</a>
<li ><a href="#method-i-on_process">#on_process</a>
<li ><a href="#method-i-on_request">#on_request</a>
<li ><a href="#method-i-process">#process</a>
<li ><a href="#method-i-remote_closed-21">#remote_closed!</a>
<li ><a href="#method-i-remote_closed-3F">#remote_closed?</a>
<li ><a href="#method-i-request_pty">#request_pty</a>
<li ><a href="#method-i-send_channel_request">#send_channel_request</a>
<li ><a href="#method-i-send_data">#send_data</a>
<li ><a href="#method-i-subsystem">#subsystem</a>
<li ><a href="#method-i-wait">#wait</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Net::SSH::Connection::Channel">
<h1 id="class-Net::SSH::Connection::Channel" class="class">
class Net::SSH::Connection::Channel
</h1>
<section class="description">
<p>The channel abstraction. Multiple “channels” can be multiplexed onto a
single <a href="../../SSH.html">SSH</a> channel, each operating
independently and seemingly in parallel. This class represents a single
such channel. Most operations performed with the <a
href="../../SSH.html">Net::SSH</a> library will involve using one or more
channels.</p>
<p>Channels are intended to be used asynchronously. You request that one be
opened (via <a
href="Session.html#method-i-open_channel">Net::SSH::Connection::Session#open_channel</a>),
and when it is opened, your callback is invoked. Then, you set various
other callbacks on the newly opened channel, which are called in response
to the corresponding events. Programming with <a
href="../../SSH.html">Net::SSH</a> works best if you think of your programs
as state machines. Complex programs are best implemented as objects that
wrap a channel. See Net::SCP and Net::SFTP for examples of how complex
state machines can be built on top of the <a href="../../SSH.html">SSH</a>
protocol.</p>
<pre class="ruby"><span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">open_channel</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">channel</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">exec</span>(<span class="ruby-string">"/invoke/some/command"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">abort</span> <span class="ruby-string">"could not execute command"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">success</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"got stdout: #{data}"</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">send_data</span> <span class="ruby-string">"something for stdin\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_extended_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"got stderr: #{data}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_close</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"channel is closing!"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">loop</span>
</pre>
<p>Channels also have a basic hash-like interface, that allows programs to
store arbitrary state information on a channel object. This helps simplify
the writing of state machines, especially when you may be juggling multiple
open channels at the same time.</p>
<p>Note that data sent across <a href="../../SSH.html">SSH</a> channels are
governed by maximum packet sizes and maximum window sizes. These details
are managed internally by <a
href="Channel.html">Net::SSH::Connection::Channel</a>, so you may remain
blissfully ignorant if you so desire, but you can always inspect the
current maximums, as well as the remaining window size, using the reader
attributes for those values.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="GOOD_LOCAL_MAXIUMUM_WINDOW_SIZE">GOOD_LOCAL_MAXIUMUM_WINDOW_SIZE
<dd>
<dt id="LOCAL_WINDOW_SIZE_INCREMENT">LOCAL_WINDOW_SIZE_INCREMENT
<dd>
<dt id="VALID_PTY_OPTIONS">VALID_PTY_OPTIONS
<dd><p>A hash of the valid PTY options (see <a
href="Channel.html#method-i-request_pty">request_pty</a>).</p>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-connection" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">connection</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The underlying <a href="Session.html">Net::SSH::Connection::Session</a>
instance that supports this channel.</p>
</div>
</div>
<div id="attribute-i-local_id" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">local_id</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The local id for this channel, assigned by the <a
href="Session.html">Net::SSH::Connection::Session</a> instance.</p>
</div>
</div>
<div id="attribute-i-local_maximum_packet_size" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">local_maximum_packet_size</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The maximum packet size that the local host can receive.</p>
</div>
</div>
<div id="attribute-i-local_maximum_window_size" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">local_maximum_window_size</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The maximum amount of data that the local end of this channel can receive.
This is a total, not per-packet.</p>
</div>
</div>
<div id="attribute-i-local_window_size" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">local_window_size</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>This is the remaining window size on the local end of this channel. When
this reaches zero, no more data can be received.</p>
</div>
</div>
<div id="attribute-i-properties" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">properties</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>A hash of properties for this channel. These can be used to store state
information about this channel. See also <a
href="Channel.html#method-i-5B-5D">[]</a> and <a
href="Channel.html#method-i-5B-5D-3D">[]=</a>.</p>
</div>
</div>
<div id="attribute-i-remote_id" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">remote_id</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The remote id for this channel, assigned by the remote host.</p>
</div>
</div>
<div id="attribute-i-remote_maximum_packet_size" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">remote_maximum_packet_size</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The maximum packet size that the remote host can receive.</p>
</div>
</div>
<div id="attribute-i-remote_maximum_window_size" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">remote_maximum_window_size</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The maximum amount of data that the remote end of this channel can receive.
This is a total, not per-packet.</p>
</div>
</div>
<div id="attribute-i-remote_window_size" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">remote_window_size</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>This is the remaining window size on the remote end of this channel. When
this reaches zero, no more data can be sent.</p>
</div>
</div>
<div id="attribute-i-type" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">type</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The type of this channel, usually “session”.</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">(connection, type, local_id, max_pkt_size = 0x8000, max_win_size = 0x20000, &on_confirm_open)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Instantiates a new channel on the given connection, of the given type, and
with the given id. If a block is given, it will be remembered until the
channel is confirmed open by the server, and will be invoked at that time
(see do_open_confirmation).</p>
<p>This also sets the default maximum packet size and maximum window size.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 113</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">connection</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">local_id</span>, <span class="ruby-identifier">max_pkt_size</span> = <span class="ruby-value">0x8000</span>, <span class="ruby-identifier">max_win_size</span> = <span class="ruby-value">0x20000</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">on_confirm_open</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">logger</span> = <span class="ruby-identifier">connection</span>.<span class="ruby-identifier">logger</span>
<span class="ruby-ivar">@connection</span> = <span class="ruby-identifier">connection</span>
<span class="ruby-ivar">@type</span> = <span class="ruby-identifier">type</span>
<span class="ruby-ivar">@local_id</span> = <span class="ruby-identifier">local_id</span>
<span class="ruby-ivar">@local_maximum_packet_size</span> = <span class="ruby-identifier">max_pkt_size</span>
<span class="ruby-ivar">@local_window_size</span> = <span class="ruby-ivar">@local_maximum_window_size</span> = <span class="ruby-identifier">max_win_size</span>
<span class="ruby-ivar">@on_confirm_open</span> = <span class="ruby-identifier">on_confirm_open</span>
<span class="ruby-ivar">@output</span> = <span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@properties</span> = {}
<span class="ruby-ivar">@pending_requests</span> = []
<span class="ruby-ivar">@on_open_failed</span> = <span class="ruby-ivar">@on_data</span> = <span class="ruby-ivar">@on_extended_data</span> = <span class="ruby-ivar">@on_process</span> = <span class="ruby-ivar">@on_close</span> = <span class="ruby-ivar">@on_eof</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@on_request</span> = {}
<span class="ruby-ivar">@closing</span> = <span class="ruby-ivar">@eof</span> = <span class="ruby-ivar">@sent_eof</span> = <span class="ruby-ivar">@local_closed</span> = <span class="ruby-ivar">@remote_closed</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A shortcut for accessing properties of the channel (see <a
href="Channel.html#attribute-i-properties">properties</a>).</p>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 136</span>
<span class="ruby-keyword">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">name</span>)
<span class="ruby-ivar">@properties</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-5B-5D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]=</span><span
class="method-args">(name, value)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A shortcut for setting properties of the channel (see <a
href="Channel.html#attribute-i-properties">properties</a>).</p>
<div class="method-source-code" id="5B-5D-3D-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 141</span>
<span class="ruby-keyword">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span>)
<span class="ruby-ivar">@properties</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-active-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">active?</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 channel exists in the channel list of the session, and
false otherwise. This can be used to determine whether a channel has been
closed or not.</p>
<pre class="ruby"><span class="ruby-identifier">ssh</span>.<span class="ruby-identifier">loop</span> { <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">active?</span> }
</pre>
<div class="method-source-code" id="active-3F-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 262</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">active?</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">channels</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">local_id</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>Requests that the channel be closed. It only marks the channel to be closed
the CHANNEL_CLOSE message will be sent from event loop</p>
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 299</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">close</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@closing</span>
<span class="ruby-ivar">@closing</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-closing-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">closing?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>True if close() has been called; NOTE: if the channel has data waiting to
be sent then the channel will close after all the data is sent. See
closed?() to determine if we have actually sent CHANNEL_CLOSE to server.
This may be true for awhile before closed? returns true if we are still
sending buffered output to server.</p>
<div class="method-source-code" id="closing-3F-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 280</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">closing?</span>
<span class="ruby-ivar">@closing</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Invokes the <a href="Channel.html#method-i-on_close">on_close</a> callback
when the server closes a channel. The channel is the only argument.</p>
<div class="method-source-code" id="do_close-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 609</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">do_close</span>
<span class="ruby-ivar">@on_close</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@on_close</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_eof" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_eof</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Invokes the <a href="Channel.html#method-i-on_eof">on_eof</a> callback when
the server indicates that no further data is forthcoming. The callback is
invoked with the channel as the argument.</p>
<div class="method-source-code" id="do_eof-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 603</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">do_eof</span>
<span class="ruby-ivar">@on_eof</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@on_eof</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_extended_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_extended_data</span><span
class="method-args">(type, data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Invokes the <a
href="Channel.html#method-i-on_extended_data">on_extended_data</a> callback
when the server sends extended data to the channel. This will reduce the
available window size on the local end. The callback is invoked with the
channel, type, and data.</p>
<div class="method-source-code" id="do_extended_data-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 595</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">do_extended_data</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span>)
<span class="ruby-identifier">update_local_window_size</span>(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">length</span>)
<span class="ruby-ivar">@on_extended_data</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@on_extended_data</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_failure" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_failure</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Invokes the next pending request callback with <code>false</code> as the
second argument.</p>
<div class="method-source-code" id="do_failure-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 615</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">do_failure</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">callback</span> = <span class="ruby-identifier">pending_requests</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-identifier">callback</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>, <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">error</span> { <span class="ruby-string">"channel failure received with no pending request to handle it (bug?)"</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_open_failed" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_open_failed</span><span
class="method-args">(reason_code, description)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Invoked when the server failed to open the channel. If an <a
href="Channel.html#method-i-on_open_failed">on_open_failed</a> callback was
specified, it will be invoked with the channel, reason code, and
description as arguments. Otherwise, a <a
href="../ChannelOpenFailed.html">ChannelOpenFailed</a> exception will be
raised.</p>
<div class="method-source-code" id="do_open_failed-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 540</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">do_open_failed</span>(<span class="ruby-identifier">reason_code</span>, <span class="ruby-identifier">description</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@on_open_failed</span>
<span class="ruby-ivar">@on_open_failed</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">reason_code</span>, <span class="ruby-identifier">description</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ChannelOpenFailed</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">reason_code</span>, <span class="ruby-identifier">description</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_success" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_success</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Invokes the next pending request callback with <code>true</code> as the
second argument.</p>
<div class="method-source-code" id="do_success-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 625</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">do_success</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">callback</span> = <span class="ruby-identifier">pending_requests</span>.<span class="ruby-identifier">shift</span>
<span class="ruby-identifier">callback</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">error</span> { <span class="ruby-string">"channel success received with no pending request to handle it (bug?)"</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-env" class="method-detail ">
<div class="method-heading">
<span class="method-name">env</span><span
class="method-args">(variable_name, variable_value, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Syntactic sugar for setting an environment variable in the remote
process' environment. Note that for security reasons, the server may
refuse to set certain environment variables, or all, at the server's
discretion. If you are connecting to an OpenSSH server, you will need to
update the AcceptEnv setting in the sshd_config to include the environment
variables you want to send.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">env</span> <span class="ruby-string">"PATH"</span>, <span class="ruby-string">"/usr/local/bin"</span>
</pre>
<div class="method-source-code" id="env-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 190</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">env</span>(<span class="ruby-identifier">variable_name</span>, <span class="ruby-identifier">variable_value</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">send_channel_request</span>(<span class="ruby-string">"env"</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">variable_name</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">variable_value</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-eof-21" 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>Tells the remote end of the channel that no more data is forthcoming from
this end of the channel. The remote end may still send data. The
CHANNEL_EOF packet will be sent once the output buffer is empty.</p>
<div class="method-source-code" id="eof-21-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 314</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">eof!</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">eof?</span>
<span class="ruby-ivar">@eof</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</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 local end of the channel has declared that no more data
is forthcoming (see <a href="Channel.html#method-i-eof-21">eof!</a>).
Trying to send data via <a
href="Channel.html#method-i-send_data">send_data</a> when this is true will
result in an exception being raised.</p>
<div class="method-source-code" id="eof-3F-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 307</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">eof?</span>
<span class="ruby-ivar">@eof</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-exec" class="method-detail ">
<div class="method-heading">
<span class="method-name">exec</span><span
class="method-args">(command, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Syntactic sugar for executing a command. Sends a channel request asking
that the given command be invoked. If the block is given, it will be called
when the server responds. The first parameter will be the channel, and the
second will be true or false, indicating whether the request succeeded or
not. In this case, success means that the command is being executed, not
that it has completed, and failure means that the command altogether failed
to be executed.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">exec</span> <span class="ruby-string">"ls -l /home"</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">success</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"command has begun executing..."</span>
<span class="ruby-comment"># this is a good place to hang callbacks like #on_data...</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"alas! the command could not be invoked!"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="exec-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 161</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">exec</span>(<span class="ruby-identifier">command</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">send_channel_request</span>(<span class="ruby-string">"exec"</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">command</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-local_closed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">local_closed?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>True if we have sent CHANNEL_CLOSE to the remote server.</p>
<div class="method-source-code" id="local_closed-3F-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 285</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">local_closed?</span>
<span class="ruby-ivar">@local_closed</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-on_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">on_close</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers a callback to be invoked when the server acknowledges that a
channel is closed. This is invoked with the channel as the sole argument.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_close</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"remote end is closing!"</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="on_close-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 401</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_close</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">old</span>, <span class="ruby-ivar">@on_close</span> = <span class="ruby-ivar">@on_close</span>, <span class="ruby-identifier">block</span>
<span class="ruby-identifier">old</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-on_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">on_data</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers a callback to be invoked when data packets are received by the
channel. The callback is called with the channel as the first argument, and
the data as the second.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"got data: #{data.inspect}"</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Data received this way is typically the data written by the remote process
to its <code>stdout</code> stream.</p>
<div class="method-source-code" id="on_data-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 348</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_data</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">old</span>, <span class="ruby-ivar">@on_data</span> = <span class="ruby-ivar">@on_data</span>, <span class="ruby-identifier">block</span>
<span class="ruby-identifier">old</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-on_eof" class="method-detail ">
<div class="method-heading">
<span class="method-name">on_eof</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers a callback to be invoked when the server indicates that no more
data will be sent to the channel (although the channel can still send data
to the server). The channel is the sole argument to the callback.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_eof</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"remote end is done sending data"</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="on_eof-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 413</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_eof</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">old</span>, <span class="ruby-ivar">@on_eof</span> = <span class="ruby-ivar">@on_eof</span>, <span class="ruby-identifier">block</span>
<span class="ruby-identifier">old</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-on_extended_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">on_extended_data</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers a callback to be invoked when extended data packets are received
by the channel. The callback is called with the channel as the first
argument, the data type (as an integer) as the second, and the data as the
third. Extended data is almost exclusively used to send <code>stderr</code>
data (<code>type</code> == 1). Other extended data types are not defined by
the <a href="../../SSH.html">SSH</a> protocol.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_extended_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"got stderr: #{data.inspect}"</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="on_extended_data-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 363</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_extended_data</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">old</span>, <span class="ruby-ivar">@on_extended_data</span> = <span class="ruby-ivar">@on_extended_data</span>, <span class="ruby-identifier">block</span>
<span class="ruby-identifier">old</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-on_open_failed" class="method-detail ">
<div class="method-heading">
<span class="method-name">on_open_failed</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers a callback to be invoked when the server was unable to open the
requested channel. The channel itself will be passed to the block, along
with the integer “reason code” for the failure, and a textual description
of the failure from the server.</p>
<pre>channel = session.open_channel do |ch|
# ..
end
channel.on_open_failed { |ch, code, desc| ... }</pre>
<div class="method-source-code" id="on_open_failed-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 428</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_open_failed</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">old</span>, <span class="ruby-ivar">@on_open_failed</span> = <span class="ruby-ivar">@on_open_failed</span>, <span class="ruby-identifier">block</span>
<span class="ruby-identifier">old</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-on_process" class="method-detail ">
<div class="method-heading">
<span class="method-name">on_process</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers a callback to be invoked for each pass of the event loop for this
channel. There are no guarantees on timeliness in the event loop, but it
will be called roughly once for each packet received by the connection (not
the channel). This callback is invoked with the channel as the sole
argument.</p>
<p>Here's an example that accumulates the channel data into a variable on
the channel itself, and displays individual lines in the input one at a
time when the channel is processed:</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>[:<span class="ruby-identifier">data</span>] = <span class="ruby-string">""</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_data</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">channel</span>[:<span class="ruby-identifier">data</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">data</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_process</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">channel</span>[:<span class="ruby-identifier">data</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^.*?\n/</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">$&</span>
<span class="ruby-identifier">channel</span>[:<span class="ruby-identifier">data</span>] = <span class="ruby-node">$'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="on_process-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 390</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_process</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">old</span>, <span class="ruby-ivar">@on_process</span> = <span class="ruby-ivar">@on_process</span>, <span class="ruby-identifier">block</span>
<span class="ruby-identifier">old</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-on_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">on_request</span><span
class="method-args">(type, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Registers a callback to be invoked when a channel request of the given type
is received. The callback will receive the channel as the first argument,
and the associated (unparsed) data as the second. The data will be a <a
href="../Buffer.html">Net::SSH::Buffer</a> that you will need to parse,
yourself, according to the kind of request you are watching.</p>
<p>By default, if the request wants a reply, <a
href="../../SSH.html">Net::SSH</a> will send a CHANNEL_SUCCESS response for
any request that was handled by a registered callback, and CHANNEL_FAILURE
for any that wasn't, but if you want your registered callback to result
in a CHANNEL_FAILURE response, just raise <a
href="../ChannelRequestFailed.html">Net::SSH::ChannelRequestFailed</a>.</p>
<p>Some common channel requests that your programs might want to listen for
are:</p>
<ul><li>
<p>“exit-status” : the exit status of the remote process will be reported as a
long integer in the data buffer, which you can grab via data.read_long.</p>
</li><li>
<p>“exit-signal” : if the remote process died as a result of a signal being
sent to it, the signal will be reported as a string in the data, via
data.read_string. (Not all <a href="../../SSH.html">SSH</a> servers support
this channel request type.)</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">on_request</span> <span class="ruby-string">"exit-status"</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">data</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"process terminated with exit status: #{data.read_long}"</span>
<span class="ruby-keyword">end</span>
</pre>
</li></ul>
<div class="method-source-code" id="on_request-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 459</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">on_request</span>(<span class="ruby-identifier">type</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">old</span>, <span class="ruby-ivar">@on_request</span>[<span class="ruby-identifier">type</span>] = <span class="ruby-ivar">@on_request</span>[<span class="ruby-identifier">type</span>], <span class="ruby-identifier">block</span>
<span class="ruby-identifier">old</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-process" class="method-detail ">
<div class="method-heading">
<span class="method-name">process</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>If an <a href="Channel.html#method-i-on_process">on_process</a> handler has
been set up, this will cause it to be invoked (passing the channel itself
as an argument). It also causes all pending output to be enqueued as
CHANNEL_DATA packets (see enqueue_pending_output).</p>
<div class="method-source-code" id="process-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 322</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">process</span>
<span class="ruby-ivar">@on_process</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@on_process</span>
<span class="ruby-identifier">enqueue_pending_output</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@eof</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@sent_eof</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">output</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">remote_id</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@local_closed</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">from</span>(<span class="ruby-value">:byte</span>, <span class="ruby-constant">CHANNEL_EOF</span>, <span class="ruby-value">:long</span>, <span class="ruby-identifier">remote_id</span>))
<span class="ruby-ivar">@sent_eof</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@closing</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">not</span> <span class="ruby-ivar">@local_closed</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">output</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">remote_id</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">from</span>(<span class="ruby-value">:byte</span>, <span class="ruby-constant">CHANNEL_CLOSE</span>, <span class="ruby-value">:long</span>, <span class="ruby-identifier">remote_id</span>))
<span class="ruby-ivar">@local_closed</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">cleanup_channel</span>(<span class="ruby-keyword">self</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remote_closed-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">remote_closed!</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="remote_closed-21-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 293</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote_closed!</span>
<span class="ruby-ivar">@remote_closed</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remote_closed-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">remote_closed?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="remote_closed-3F-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 289</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">remote_closed?</span>
<span class="ruby-ivar">@remote_closed</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-request_pty" class="method-detail ">
<div class="method-heading">
<span class="method-name">request_pty</span><span
class="method-args">(opts={}, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Requests that a pseudo-tty (or “pty”) be made available for this channel.
This is useful when you want to invoke and interact with some kind of
screen-based program (e.g., vim, or some menuing system).</p>
<p>Note, that without a pty some programs (e.g. sudo, or subversion) on some
systems, will not be able to run interactively, and will error instead of
prompt if they ever need some user interaction.</p>
<p>Note, too, that when a pty is requested, user's shell configuration
scripts (.bashrc and such) are not run by default, whereas they are run
when a pty is not present.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">request_pty</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">success</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"pty successfully obtained"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"could not obtain pty"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="request_pty-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 221</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">request_pty</span>(<span class="ruby-identifier">opts</span>={}, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">extra</span> = <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">keys</span> <span class="ruby-operator">-</span> <span class="ruby-constant">VALID_PTY_OPTIONS</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">"invalid option(s) to request_pty: #{extra.inspect}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">extra</span>.<span class="ruby-identifier">any?</span>
<span class="ruby-identifier">opts</span> = <span class="ruby-constant">VALID_PTY_OPTIONS</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>)
<span class="ruby-identifier">modes</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:modes</span>].<span class="ruby-identifier">inject</span>(<span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">new</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">memo</span>, (<span class="ruby-identifier">mode</span>, <span class="ruby-identifier">data</span>)<span class="ruby-operator">|</span>
<span class="ruby-identifier">memo</span>.<span class="ruby-identifier">write_byte</span>(<span class="ruby-identifier">mode</span>).<span class="ruby-identifier">write_long</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># mark the end of the mode opcode list with a 0 byte</span>
<span class="ruby-identifier">modes</span>.<span class="ruby-identifier">write_byte</span>(<span class="ruby-value">0</span>)
<span class="ruby-identifier">send_channel_request</span>(<span class="ruby-string">"pty-req"</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:term</span>],
<span class="ruby-value">:long</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:chars_wide</span>], <span class="ruby-value">:long</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:chars_high</span>],
<span class="ruby-value">:long</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:pixels_wide</span>], <span class="ruby-value">:long</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:pixels_high</span>],
<span class="ruby-value">:string</span>, <span class="ruby-identifier">modes</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_channel_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_channel_request</span><span
class="method-args">(request_name, *data, &callback)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends a new channel request with the given name. The extra
<code>data</code> parameter must either be empty, or consist of an even
number of arguments. See <a
href="../Buffer.html#method-c-from">Net::SSH::Buffer.from</a> for a
description of their format. If a block is given, it is registered as a
callback for a pending request, and the packet will be flagged so that the
server knows a reply is required. If no block is given, the server will
send no response to this request. Responses, where required, will cause the
callback to be invoked with the channel as the first argument, and either
true or false as the second, depending on whether the request succeeded or
not. The meaning of “success” and “failure” in this context is dependent on
the specific request that was sent.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">send_channel_request</span> <span class="ruby-string">"shell"</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">success</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"user shell started successfully"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"could not start user shell"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<p>Most channel requests you'll want to send are already wrapped in more
convenient helper methods (see <a
href="Channel.html#method-i-exec">exec</a> and <a
href="Channel.html#method-i-subsystem">subsystem</a>).</p>
<div class="method-source-code" id="send_channel_request-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 486</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_channel_request</span>(<span class="ruby-identifier">request_name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">data</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">callback</span>)
<span class="ruby-identifier">info</span> { <span class="ruby-node">"sending channel request #{request_name.inspect}"</span> }
<span class="ruby-identifier">fail</span> <span class="ruby-string">"Channel open not yet confirmed, please call send_channel_request(or exec) from block of open_channel"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">remote_id</span>
<span class="ruby-identifier">msg</span> = <span class="ruby-constant">Buffer</span>.<span class="ruby-identifier">from</span>(<span class="ruby-value">:byte</span>, <span class="ruby-constant">CHANNEL_REQUEST</span>,
<span class="ruby-value">:long</span>, <span class="ruby-identifier">remote_id</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">request_name</span>,
<span class="ruby-value">:bool</span>, <span class="ruby-operator">!</span><span class="ruby-identifier">callback</span>.<span class="ruby-identifier">nil?</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">data</span>)
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">send_message</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-identifier">pending_requests</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">callback</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">callback</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-send_data" class="method-detail ">
<div class="method-heading">
<span class="method-name">send_data</span><span
class="method-args">(data)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sends data to the channel's remote endpoint. This usually has the
effect of sending the given string to the remote process' stdin stream.
Note that it does not immediately send the data across the channel, but
instead merely appends the given data to the channel's output buffer,
preparatory to being packaged up and sent out the next time the connection
is accepting data. (A connection might not be accepting data if, for
instance, it has filled its data window and has not yet been resized by the
remote end-point.)</p>
<p>This will raise an exception if the channel has previously declared that no
more data will be sent (see <a
href="Channel.html#method-i-eof-21">eof!</a>).</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">send_data</span>(<span class="ruby-string">"the password\n"</span>)
</pre>
<div class="method-source-code" id="send_data-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 252</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_data</span>(<span class="ruby-identifier">data</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">EOFError</span>, <span class="ruby-string">"cannot send data if channel has declared eof"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">eof?</span>
<span class="ruby-identifier">output</span>.<span class="ruby-identifier">append</span>(<span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-subsystem" class="method-detail ">
<div class="method-heading">
<span class="method-name">subsystem</span><span
class="method-args">(subsystem, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Syntactic sugar for requesting that a subsystem be started. Subsystems are
a way for other protocols (like SFTP) to be run, using <a
href="../../SSH.html">SSH</a> as the transport. Generally, you'll never
need to call this directly unless you are the implementor of something that
consumes an <a href="../../SSH.html">SSH</a> subsystem, like SFTP.</p>
<pre class="ruby"><span class="ruby-identifier">channel</span>.<span class="ruby-identifier">subsystem</span>(<span class="ruby-string">"sftp"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ch</span>, <span class="ruby-identifier">success</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">success</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"subsystem successfully started"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">puts</span> <span class="ruby-string">"subsystem could not be started"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="subsystem-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 178</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">subsystem</span>(<span class="ruby-identifier">subsystem</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">send_channel_request</span>(<span class="ruby-string">"subsystem"</span>, <span class="ruby-value">:string</span>, <span class="ruby-identifier">subsystem</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-wait" class="method-detail ">
<div class="method-heading">
<span class="method-name">wait</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Runs the <a href="../../SSH.html">SSH</a> event loop until the channel is
no longer active. This is handy for blocking while you wait for some
channel to finish.</p>
<pre>channel.exec("grep ...") { ... }
channel.wait</pre>
<div class="method-source-code" id="wait-source">
<pre><span class="ruby-comment"># File lib/net/ssh/connection/channel.rb, line 271</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">wait</span>
<span class="ruby-identifier">connection</span>.<span class="ruby-identifier">loop</span> { <span class="ruby-identifier">active?</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="http://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.0.0.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
|
