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
|
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ARC Graphical Clients: FileTransfer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>FileTransfer Class Reference</h1><!-- doxytag: class="FileTransfer" -->
<p>Represents a single data transfer from one url to another.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="filetransfer_8h_source.html">filetransfer.h</a>></code></p>
<p><a href="classFileTransfer-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a27387942c6eaf287746a491f546791ff">onProgress</a> (<a class="el" href="classFileTransfer.html">FileTransfer</a> *fileTransfer, unsigned long long bytesTransferred, unsigned long long bytesTotal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal for updating transfer status. <a href="#a27387942c6eaf287746a491f546791ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad1bd29b55ef78d611fdad18e31928ae"></a><!-- doxytag: member="FileTransfer::onCompleted" ref="aad1bd29b55ef78d611fdad18e31928ae" args="(FileTransfer *fileTransfer, bool success, QString error)" -->
void </td><td class="memItemRight" valign="bottom"><b>onCompleted</b> (<a class="el" href="classFileTransfer.html">FileTransfer</a> *fileTransfer, bool success, QString error)</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a0f2aa2aef9675817ccdffb5595b0d1eb">FileTransfer</a> (const std::string &source_str, const std::string &destination_str, Arc::UserConfig &usercfg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a file transfer object. <a href="#a0f2aa2aef9675817ccdffb5595b0d1eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7171fa5cd1e29c76bae7bb3810e5e082"></a><!-- doxytag: member="FileTransfer::transferState" ref="a7171fa5cd1e29c76bae7bb3810e5e082" args="()" -->
TTransferState </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a7171fa5cd1e29c76bae7bb3810e5e082">transferState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current transfer state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afba57e1d84467e85cd60c891294b21aa"></a><!-- doxytag: member="FileTransfer::execute" ref="afba57e1d84467e85cd60c891294b21aa" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#afba57e1d84467e85cd60c891294b21aa">execute</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the actual file transfer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fe970a33029d645352268687e33dd63"></a><!-- doxytag: member="FileTransfer::wait" ref="a4fe970a33029d645352268687e33dd63" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a4fe970a33029d645352268687e33dd63">wait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for the file transfer to complete. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad18f4f66878880fa74a5ebcc834a4130"></a><!-- doxytag: member="FileTransfer::status" ref="ad18f4f66878880fa74a5ebcc834a4130" args="()" -->
Arc::DataStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#ad18f4f66878880fa74a5ebcc834a4130">status</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the ARC transfer status. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a77255b1ff5556196fbc6ef13d1d3625f">completed</a> (Arc::DataStatus res, std::string error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Routine called by the ARC callbacks to indicate a failed/completed file transfer. <a href="#a77255b1ff5556196fbc6ef13d1d3625f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a4458e84260463d51b57da41a71edc7eb">cancel</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cancel the transfer. <a href="#a4458e84260463d51b57da41a71edc7eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc1f397e7eadcd0acb6a1a1111e7cce7"></a><!-- doxytag: member="FileTransfer::isCompleted" ref="adc1f397e7eadcd0acb6a1a1111e7cce7" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#adc1f397e7eadcd0acb6a1a1111e7cce7">isCompleted</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if transfer is completed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28f7e04f54b3466005fc8d5c4a3d490b"></a><!-- doxytag: member="FileTransfer::id" ref="a28f7e04f54b3466005fc8d5c4a3d490b" args="()" -->
QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a28f7e04f54b3466005fc8d5c4a3d490b">id</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return current transfer id. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44d03a37fa86e5edeb531754799eafc2"></a><!-- doxytag: member="FileTransfer::sourceUrl" ref="a44d03a37fa86e5edeb531754799eafc2" args="()" -->
QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a44d03a37fa86e5edeb531754799eafc2">sourceUrl</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return source URL. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3cfd2be9e2ed533aef999f9794a208c8"></a><!-- doxytag: member="FileTransfer::destUrl" ref="a3cfd2be9e2ed533aef999f9794a208c8" args="()" -->
QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a3cfd2be9e2ed533aef999f9794a208c8">destUrl</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return destination URL. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a4a0b8f2cda0addd90c1411adf31bf5b7">updateTransferStatus</a> (unsigned long transferred, unsigned long totalSize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Updated the current transfer statistics. <a href="#a4a0b8f2cda0addd90c1411adf31bf5b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a106871aa5f01c5a39498404c35fa2733"></a><!-- doxytag: member="FileTransfer::getTransferStatus" ref="a106871aa5f01c5a39498404c35fa2733" args="(unsigned long &transferred, unsigned long &totalSize)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransfer.html#a106871aa5f01c5a39498404c35fa2733">getTransferStatus</a> (unsigned long &transferred, unsigned long &totalSize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return current transfer statistics. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents a single data transfer from one url to another. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0f2aa2aef9675817ccdffb5595b0d1eb"></a><!-- doxytag: member="FileTransfer::FileTransfer" ref="a0f2aa2aef9675817ccdffb5595b0d1eb" args="(const std::string &source_str, const std::string &destination_str, Arc::UserConfig &usercfg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileTransfer::FileTransfer </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>source_str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>destination_str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Arc::UserConfig & </td>
<td class="paramname"> <em>usercfg</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a file transfer object. </p>
<p>Creates a file transfer object used for handling a file transfer using the ARC API:s. The transfer object is by default idle and will not start any transfers until the execute method is called. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source_str</em> </td><td>is the source URL of a file to be transferred. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>destination_str</em> </td><td>is the destination URL of the file to transferred. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>usercfg</em> </td><td>is the current ARC configuration object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4458e84260463d51b57da41a71edc7eb"></a><!-- doxytag: member="FileTransfer::cancel" ref="a4458e84260463d51b57da41a71edc7eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransfer::cancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel the transfer. </p>
<p>Currently only destroys the ARC data mover object. Graceful cancellation is currently not supported due to restrictions in the ARC API. </p>
</div>
</div>
<a class="anchor" id="a77255b1ff5556196fbc6ef13d1d3625f"></a><!-- doxytag: member="FileTransfer::completed" ref="a77255b1ff5556196fbc6ef13d1d3625f" args="(Arc::DataStatus res, std::string error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransfer::completed </td>
<td>(</td>
<td class="paramtype">Arc::DataStatus </td>
<td class="paramname"> <em>res</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>error</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Routine called by the ARC callbacks to indicate a failed/completed file transfer. </p>
<p>This routine should not be called directly. It is public so that the static callback can access the routine. </p>
</div>
</div>
<a class="anchor" id="a27387942c6eaf287746a491f546791ff"></a><!-- doxytag: member="FileTransfer::onProgress" ref="a27387942c6eaf287746a491f546791ff" args="(FileTransfer *fileTransfer, unsigned long long bytesTransferred, unsigned long long bytesTotal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransfer::onProgress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFileTransfer.html">FileTransfer</a> * </td>
<td class="paramname"> <em>fileTransfer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long long </td>
<td class="paramname"> <em>bytesTransferred</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long long </td>
<td class="paramname"> <em>bytesTotal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal for updating transfer status. </p>
<p>This signal is called whenever the ARC callback is called to convey the current transfer statistics on the ongoing file transfer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fileTransfer</em> </td><td>file transfer object that initiated the signal. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bytesTransferred</em> </td><td>currently transfers bytes </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bytesTotal</em> </td><td>total of bytes to be transferred. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4a0b8f2cda0addd90c1411adf31bf5b7"></a><!-- doxytag: member="FileTransfer::updateTransferStatus" ref="a4a0b8f2cda0addd90c1411adf31bf5b7" args="(unsigned long transferred, unsigned long totalSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransfer::updateTransferStatus </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>transferred</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>totalSize</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updated the current transfer statistics. </p>
<p>This routine should not be called directly. It is public so that the static callback can accces the routine. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/jonas/Development/arc-gui-clients/src/arcstorage-ui/<a class="el" href="filetransfer_8h_source.html">filetransfer.h</a></li>
<li>/home/jonas/Development/arc-gui-clients/src/arcstorage-ui/filetransfer.cpp</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 19 Feb 2013 for ARC Graphical Clients by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|
