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
|
<?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>
<head>
<title>Class: Net::SFTP::Protocol::PacketAssistant</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
<script language="JavaScript" type="text/javascript">
// <![CDATA[
function toggleSource( id )
{
var elem
var link
if( document.getElementById )
{
elem = document.getElementById( id )
link = document.getElementById( "l_" + id )
}
else if ( document.all )
{
elem = eval( "document.all." + id )
link = eval( "document.all.l_" + id )
}
else
return false;
if( elem.style.display == "block" )
{
elem.style.display = "none"
link.innerHTML = "show source"
}
else
{
elem.style.display = "block"
link.innerHTML = "hide source"
}
}
function openCode( url )
{
window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
}
// ]]>
</script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
<td class="file-title"><span class="file-title-prefix">Class</span><br />Net::SFTP::Protocol::PacketAssistant</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../files/lib/net/sftp/protocol/packet-assistant_rb.html">lib/net/sftp/protocol/packet-assistant.rb</a>
</td>
</tr>
<tr>
<td>Parent:</td>
<td>
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div class="description"><p>
This is the abstract base class for all <a
href="PacketAssistant.html#M000080">packet</a> assistant classes used by
the supported <a href="../../SFTP.html">SFTP</a> protocol versions.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000081">new</a></li>
<li><a href="#M000080">packet</a></li>
</ul>
<div class="sectiontitle">Attributes</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>buffers</td>
<td class='attr-desc'>
The buffer factory in use by this <a
href="PacketAssistant.html#M000080">packet</a> assistant, used to build the
packets.
</td>
</tr>
<tr valign='top'>
<td class='attr-rw'>
[R]
</td>
<td class='attr-name'>driver</td>
<td class='attr-desc'>
The protocol driver that will be used to obtain request ids.
</td>
</tr>
</table>
<div class="sectiontitle">Public Class methods</div>
<div class="method">
<div class="title">
<a name="M000081"></a><b>new</b>( buffers, driver )
</div>
<div class="description">
<p>
Create a <a href="PacketAssistant.html#M000081">new</a> <a
href="PacketAssistant.html">PacketAssistant</a>, which will use the given
buffer factory and <a href="../../SFTP.html">SFTP</a> protocol driver.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000081_source')" id="l_M000081_source">show source</a> ]</p>
<div id="M000081_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/sftp/protocol/packet-assistant.rb, line 78</span>
78: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-identifier">buffers</span>, <span class="ruby-identifier">driver</span> )
79: <span class="ruby-ivar">@buffers</span> = <span class="ruby-identifier">buffers</span>
80: <span class="ruby-ivar">@driver</span> = <span class="ruby-identifier">driver</span>
81: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000080"></a><b>packet</b>( name, *args )
</div>
<div class="description">
<p>
A helper method for defining a <a
href="PacketAssistant.html#M000081">new</a> <a
href="PacketAssistant.html#M000080">packet</a> type. The <tt>name</tt> is
the name of the <a href="PacketAssistant.html#M000080">packet</a> (and of
the corresponding method that is created), and the arguments are symbols
representing the types of each element in the <a
href="PacketAssistant.html#M000080">packet</a>. The supported types are:
</p>
<ul>
<li>:long
</li>
<li>:int64
</li>
<li>:short
</li>
<li>:byte
</li>
<li>:string
</li>
<li>:attrs
</li>
<li>:write
</li>
</ul>
<p>
The :attrs and :write types both simply convert the argument to a string.
</p>
<p>
The method that is created always supports an <tt>id</tt> parameter in the
first position, which if null will default to the next available request
id. The method returns a tuple consisting of the request id, and a string
consisting of the arguments formatted according to the <a
href="PacketAssistant.html#M000080">packet</a>‘s description.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000080_source')" id="l_M000080_source">show source</a> ]</p>
<div id="M000080_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/sftp/protocol/packet-assistant.rb, line 43</span>
43: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">packet</span>( <span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
44: <span class="ruby-identifier">body</span> = <span class="ruby-value str">""</span>
45: <span class="ruby-identifier">args</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">arg</span><span class="ruby-operator">|</span>
46: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"b.write"</span>
47: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">arg</span>
48: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:long</span>, <span class="ruby-identifier">:int64</span>, <span class="ruby-identifier">:short</span>, <span class="ruby-identifier">:byte</span>
49: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"_#{arg} args.shift.to_i"</span>
50: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:string</span>
51: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"_#{arg} args.shift.to_s"</span>
52: <span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:attrs</span>, <span class="ruby-identifier">:write</span>
53: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" args.shift.to_s"</span>
54: <span class="ruby-keyword kw">end</span>
55: <span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"\n"</span>
56: <span class="ruby-keyword kw">end</span>
57: <span class="ruby-identifier">class_eval</span> <span class="ruby-value str">"def \#{name}( id, *args )\nb = buffers.writer\nid ||= driver.next_request_id\nb.write_long id\n\#{body}\n[ id, b.to_s ]\nend\n"</span>, <span class="ruby-keyword kw">__FILE__</span>, <span class="ruby-keyword kw">__LINE__</span><span class="ruby-operator">+</span><span class="ruby-value">1</span>
58: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
