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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: Net::SSH::Service::Forward</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">Net::SSH::Service::Forward</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../../files/lib/net/ssh/service/forward/driver_rb.html">
lib/net/ssh/service/forward/driver.rb
</a>
<br />
<a href="../../../../files/lib/net/ssh/service/forward/local-network-handler_rb.html">
lib/net/ssh/service/forward/local-network-handler.rb
</a>
<br />
<a href="../../../../files/lib/net/ssh/service/forward/remote-network-handler_rb.html">
lib/net/ssh/service/forward/remote-network-handler.rb
</a>
<br />
<a href="../../../../files/lib/net/ssh/service/forward/services_rb.html">
lib/net/ssh/service/forward/services.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000283">register_services</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
Class <a href="Forward/Driver.html" class="link">Net::SSH::Service::Forward::Driver</a><br />
Class <a href="Forward/LocalNetworkHandler.html" class="link">Net::SSH::Service::Forward::LocalNetworkHandler</a><br />
Class <a href="Forward/RemoteNetworkHandler.html" class="link">Net::SSH::Service::Forward::RemoteNetworkHandler</a><br />
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000283" class="method-detail">
<a name="M000283"></a>
<div class="method-heading">
<a href="#M000283" class="method-signature">
<span class="method-name">register_services</span><span class="method-args">( container )</span>
</a>
</div>
<div class="method-description">
<p>
Register the services pertaining to port forwarding.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000283-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000283-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/forward/services.rb, line 23</span>
23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">register_services</span>( <span class="ruby-identifier">container</span> )
24:
25: <span class="ruby-comment cmt"># All port forwarding services go in the :forward namespace.</span>
26: <span class="ruby-identifier">container</span>.<span class="ruby-identifier">namespace_define</span> <span class="ruby-identifier">:forward</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ns</span><span class="ruby-operator">|</span>
27:
28: <span class="ruby-comment cmt"># The :driver service manages all port forwarding. It is declared</span>
29: <span class="ruby-comment cmt"># as deferred so that it is not actually instantiated until it is</span>
30: <span class="ruby-comment cmt"># used--otherwise, it would be instantiated as soon as it was added</span>
31: <span class="ruby-comment cmt"># to the list of available services, whether it was ever used or</span>
32: <span class="ruby-comment cmt"># not.</span>
33: <span class="ruby-identifier">ns</span>.<span class="ruby-identifier">driver</span> <span class="ruby-identifier">:model</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:singleton_deferred</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
34: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/service/forward/driver'</span>
35: <span class="ruby-constant">Driver</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:connection</span>][<span class="ruby-identifier">:driver</span>],
36: <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:transport</span>][<span class="ruby-identifier">:buffers</span>],
37: <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:log_for</span>, <span class="ruby-identifier">p</span>],
38: <span class="ruby-identifier">:local</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:local_network_handler</span>],
39: <span class="ruby-identifier">:remote</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:remote_network_handler</span>] )
40: <span class="ruby-keyword kw">end</span>
41:
42: <span class="ruby-comment cmt"># A constant service, used to indicate the maximum block size to be</span>
43: <span class="ruby-comment cmt"># passed over a forwarded connection.</span>
44: <span class="ruby-identifier">ns</span>.<span class="ruby-identifier">read_block_size</span> { <span class="ruby-value">64</span> <span class="ruby-operator">*</span> <span class="ruby-value">1024</span> }
45:
46: <span class="ruby-comment cmt"># The :local_network_handler service returns a proc object that</span>
47: <span class="ruby-comment cmt"># creates new LocalNetworkHandler instances for a given client</span>
48: <span class="ruby-comment cmt"># connection. This is used for forwarding ports on the local host.</span>
49: <span class="ruby-identifier">ns</span>.<span class="ruby-identifier">local_network_handler</span> <span class="ruby-identifier">:model</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:singleton_deferred</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
50: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/service/forward/local-network-handler'</span>
51: <span class="ruby-identifier">log</span> = <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:log_for</span>, <span class="ruby-identifier">p</span>]
52: <span class="ruby-identifier">block_size</span> = <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:read_block_size</span>]
53: <span class="ruby-identifier">lambda</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">client</span><span class="ruby-operator">|</span>
54: <span class="ruby-constant">LocalNetworkHandler</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">log</span>, <span class="ruby-identifier">block_size</span>, <span class="ruby-identifier">client</span> )
55: <span class="ruby-keyword kw">end</span>
56: <span class="ruby-keyword kw">end</span>
57:
58: <span class="ruby-comment cmt"># The :remote_network_handler service returns a proc object that</span>
59: <span class="ruby-comment cmt"># creates new RemoteNetworkHandler instances for a given port and</span>
60: <span class="ruby-comment cmt"># host. This is used for forwarding ports on a remote host.</span>
61: <span class="ruby-identifier">ns</span>.<span class="ruby-identifier">remote_network_handler</span> <span class="ruby-identifier">:model</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:singleton_deferred</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
62: <span class="ruby-identifier">require</span> <span class="ruby-value str">'net/ssh/service/forward/remote-network-handler'</span>
63: <span class="ruby-identifier">log</span> = <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:log_for</span>, <span class="ruby-identifier">p</span>]
64: <span class="ruby-identifier">block_size</span> = <span class="ruby-identifier">c</span>[<span class="ruby-identifier">:read_block_size</span>]
65: <span class="ruby-identifier">lambda</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">port</span>, <span class="ruby-identifier">host</span><span class="ruby-operator">|</span>
66: <span class="ruby-constant">RemoteNetworkHandler</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">log</span>, <span class="ruby-identifier">block_size</span>, <span class="ruby-identifier">port</span>, <span class="ruby-identifier">host</span> )
67: <span class="ruby-keyword kw">end</span>
68: <span class="ruby-keyword kw">end</span>
69: <span class="ruby-keyword kw">end</span>
70: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
