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
|
<?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::Operations::Write</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::Operations::Write</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
<a href="../../../../files/lib/net/sftp/operations/write_rb.html">lib/net/sftp/operations/write.rb</a>
</td>
</tr>
<tr>
<td>Parent:</td>
<td>
<a href="Abstract.html">
Abstract
</a>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div class="description"><p>
Implements the <tt>write</tt> operation. Handles, automatically, the
looping necessary to write a large data set.
</p>
</div>
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000035">do_status</a></li>
<li><a href="#M000034">perform</a></li>
</ul>
<div class="sectiontitle">Constants</div>
<table border='0' cellpadding='5'>
<tr valign='top'>
<td class="attr-name">CHUNK_SIZE</td>
<td>=</td>
<td class="attr-value">32 * 1024</td>
</tr>
<tr valign='top'>
<td> </td>
<td colspan="2" class="attr-desc">
The maximum size of data that will be written at one time.
</td>
</tr>
</table>
<div class="sectiontitle">Public Instance methods</div>
<div class="method">
<div class="title">
<a name="M000035"></a><b>do_status</b>( code, message, language )
</div>
<div class="description">
<p>
Invoked when the server sends a status packet. If the status is FX_OK, then
the callback is invoked (if all data has been written), or the next chunk
is written to the server (if more data remains). Other status codes are
handled by the superclass.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000035_source')" id="l_M000035_source">show source</a> ]</p>
<div id="M000035_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/sftp/operations/write.rb, line 44</span>
44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">do_status</span>( <span class="ruby-identifier">code</span>, <span class="ruby-identifier">message</span>, <span class="ruby-identifier">language</span> )
45: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-constant">FX_OK</span>
46: <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"[#{@id}] chunk written"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">debug?</span>
47: <span class="ruby-ivar">@pos</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">CHUNK_SIZE</span>
48:
49: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@pos</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">length</span>
50: <span class="ruby-ivar">@callback</span>[ <span class="ruby-constant">OK</span> ]
51: <span class="ruby-keyword kw">return</span>
52: <span class="ruby-keyword kw">end</span>
53:
54: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">write</span> <span class="ruby-ivar">@id</span>, <span class="ruby-ivar">@handle</span>, <span class="ruby-ivar">@offset</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@pos</span>, <span class="ruby-ivar">@data</span>[<span class="ruby-ivar">@pos</span>,<span class="ruby-constant">CHUNK_SIZE</span>]
55: <span class="ruby-ivar">@session</span>.<span class="ruby-identifier">register</span> <span class="ruby-ivar">@id</span>, <span class="ruby-keyword kw">self</span>
56: <span class="ruby-keyword kw">else</span>
57: <span class="ruby-keyword kw">super</span>
58: <span class="ruby-keyword kw">end</span>
59: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000034"></a><b>perform</b>( handle, data, offset=0 )
</div>
<div class="description">
<p>
Perform the operation. Only CHUNK_SIZE portions of the <tt>data</tt>
parameter will be written at a time, with subsequent chunks being writteni
automatically when prior chunks complete.
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000034_source')" id="l_M000034_source">show source</a> ]</p>
<div id="M000034_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/net/sftp/operations/write.rb, line 31</span>
31: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">perform</span>( <span class="ruby-identifier">handle</span>, <span class="ruby-identifier">data</span>, <span class="ruby-identifier">offset</span>=<span class="ruby-value">0</span> )
32: <span class="ruby-ivar">@handle</span> = <span class="ruby-identifier">handle</span>
33: <span class="ruby-ivar">@offset</span> = <span class="ruby-identifier">offset</span>
34: <span class="ruby-ivar">@data</span> = <span class="ruby-identifier">data</span>
35: <span class="ruby-ivar">@pos</span> = <span class="ruby-value">0</span>
36:
37: <span class="ruby-ivar">@driver</span>.<span class="ruby-identifier">write</span>( <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">handle</span>, <span class="ruby-identifier">offset</span>, <span class="ruby-identifier">data</span>[<span class="ruby-value">0</span>,<span class="ruby-constant">CHUNK_SIZE</span>] )
38: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
|
