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
|
<?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>Class: Net::SSH::Service::Forward::LocalNetworkHandler</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>Class</strong></td>
<td class="class-name-in-header">Net::SSH::Service::Forward::LocalNetworkHandler</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../../../files/lib/net/ssh/service/forward/local-network-handler_rb.html">
lib/net/ssh/service/forward/local-network-handler.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
This is a utility class used internally by <a
href="Driver.html">Forward::Driver</a>. It manages the network server
instance for each locally forwarded port, and is passed as the handler to
<a href="Driver.html#M000294">Driver#direct_channel</a> by
Forward::Driver#forward_local. Other clients may desire to extend this
class and pass the modified class to <a
href="Driver.html#M000294">Forward::Driver#direct_channel</a> for their own
purposes, but in general this class will rarely be used outside of <a
href="Driver.html">Forward::Driver</a>.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000284">new</a>
<a href="#M000286">on_eof</a>
<a href="#M000285">on_receive</a>
<a href="#M000287">process</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000284" class="method-detail">
<a name="M000284"></a>
<div class="method-heading">
<a href="#M000284" class="method-signature">
<span class="method-name">new</span><span class="method-args">( log, block_size, client )</span>
</a>
</div>
<div class="method-description">
<p>
Create a new <a href="LocalNetworkHandler.html">LocalNetworkHandler</a> for
the given client connection.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000284-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000284-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/forward/local-network-handler.rb, line 32</span>
32: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">log</span>, <span class="ruby-identifier">block_size</span>, <span class="ruby-identifier">client</span> )
33: <span class="ruby-ivar">@log</span> = <span class="ruby-identifier">log</span>
34: <span class="ruby-ivar">@block_size</span> = <span class="ruby-identifier">block_size</span>
35: <span class="ruby-ivar">@client</span> = <span class="ruby-identifier">client</span>
36: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000286" class="method-detail">
<a name="M000286"></a>
<div class="method-heading">
<a href="#M000286" class="method-signature">
<span class="method-name">on_eof</span><span class="method-args">( channel )</span>
</a>
</div>
<div class="method-description">
<p>
Invoked when the remote end of the channel will no longer be sending data.
It may still receive data, however.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000286-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000286-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/forward/local-network-handler.rb, line 46</span>
46: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">on_eof</span>( <span class="ruby-identifier">channel</span> )
47: <span class="ruby-identifier">channel</span>[<span class="ruby-identifier">:eof</span>] = <span class="ruby-keyword kw">true</span>
48: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000285" class="method-detail">
<a name="M000285"></a>
<div class="method-heading">
<a href="#M000285" class="method-signature">
<span class="method-name">on_receive</span><span class="method-args">( channel, data )</span>
</a>
</div>
<div class="method-description">
<p>
Invoked when data is recieved from the channel. This method just sends the
data to the client connection.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000285-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000285-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/forward/local-network-handler.rb, line 40</span>
40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">on_receive</span>( <span class="ruby-identifier">channel</span>, <span class="ruby-identifier">data</span> )
41: <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">send</span> <span class="ruby-identifier">data</span>, <span class="ruby-value">0</span>
42: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000287" class="method-detail">
<a name="M000287"></a>
<div class="method-heading">
<a href="#M000287" class="method-signature">
<span class="method-name">process</span><span class="method-args">( channel )</span>
</a>
</div>
<div class="method-description">
<p>
Called to process the channel in a loop. It will repeatedly read from the
client and send the results across the channel.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000287-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000287-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/ssh/service/forward/local-network-handler.rb, line 52</span>
52: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process</span>( <span class="ruby-identifier">channel</span> )
53: <span class="ruby-identifier">loop</span> <span class="ruby-keyword kw">do</span>
54: <span class="ruby-keyword kw">break</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">channel</span>[<span class="ruby-identifier">:eof</span>]
55: <span class="ruby-identifier">data</span> = <span class="ruby-ivar">@client</span>.<span class="ruby-identifier">recv</span>(<span class="ruby-ivar">@block_size</span>) <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">break</span>
56: <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">send_data</span> <span class="ruby-identifier">data</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">empty?</span>
57: <span class="ruby-keyword kw">end</span>
58:
59: <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">close</span>
60: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
61: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"error processing connection: "</span> <span class="ruby-operator">+</span>
62: <span class="ruby-node">"#{e.class} (#{e.message})\n "</span> <span class="ruby-operator">+</span>
63: <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n "</span>)
64: <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>
|
