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
293
294
295
296
297
298
299
300
301
302
303
304
|
<!-- 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: FileTransferList 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>FileTransferList Class Reference</h1><!-- doxytag: class="FileTransferList" -->
<p>Maintains a global file transfer processing list.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="filetransferlist_8h_source.html">filetransferlist.h</a>></code></p>
<p><a href="classFileTransferList-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"><a class="anchor" id="afbdd0388fac6b596890d99ec5f464044"></a><!-- doxytag: member="FileTransferList::onUpdateStatus" ref="afbdd0388fac6b596890d99ec5f464044" args="(QString id)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#afbdd0388fac6b596890d99ec5f464044">onUpdateStatus</a> (QString id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is sent when there is updates in file processing. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17e783d79b2e1da1ddd6b0e9fa96ef3a"></a><!-- doxytag: member="FileTransferList::onAddTransfer" ref="a17e783d79b2e1da1ddd6b0e9fa96ef3a" args="(QString id)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a17e783d79b2e1da1ddd6b0e9fa96ef3a">onAddTransfer</a> (QString id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is sent when a file transfer is added to the list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af811955a9169c82feb92cfec90b75b45"></a><!-- doxytag: member="FileTransferList::onRemoveTransfer" ref="af811955a9169c82feb92cfec90b75b45" args="(QString id)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#af811955a9169c82feb92cfec90b75b45">onRemoveTransfer</a> (QString id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This signal is sent when a file transfer is removed from the list. <br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a92ad0c960ff3a7d3a37a28bcd8dd0bbb">processTransfers</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Drives the file transfer processing. <a href="#a92ad0c960ff3a7d3a37a28bcd8dd0bbb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13ab77c4af630e6563f0039f2e24a771"></a><!-- doxytag: member="FileTransferList::setProcessingThread" ref="a13ab77c4af630e6563f0039f2e24a771" args="(FileTransferProcessingThread *processingThread)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a13ab77c4af630e6563f0039f2e24a771">setProcessingThread</a> (<a class="el" href="classFileTransferProcessingThread.html">FileTransferProcessingThread</a> *processingThread)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the file processing thread used. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06757dd68340af3857b3d80fbe647266"></a><!-- doxytag: member="FileTransferList::addTransfer" ref="a06757dd68340af3857b3d80fbe647266" args="(FileTransfer *fileTransfer)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a06757dd68340af3857b3d80fbe647266">addTransfer</a> (<a class="el" href="classFileTransfer.html">FileTransfer</a> *fileTransfer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object to the list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6d85b1fcf8745ee7845a215c3231bb0"></a><!-- doxytag: member="FileTransferList::removeTransfer" ref="ae6d85b1fcf8745ee7845a215c3231bb0" args="(FileTransfer *fileTransfer)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#ae6d85b1fcf8745ee7845a215c3231bb0">removeTransfer</a> (<a class="el" href="classFileTransfer.html">FileTransfer</a> *fileTransfer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object from the list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFileTransfer.html">FileTransfer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a1e3efea6feca070a33cfa06c562db4ee">getTransfer</a> (int i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object from the list. <a href="#a1e3efea6feca070a33cfa06c562db4ee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ad8accb2800e44c09c16fa99a588e50"></a><!-- doxytag: member="FileTransferList::getTransferCount" ref="a1ad8accb2800e44c09c16fa99a588e50" args="()" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a1ad8accb2800e44c09c16fa99a588e50">getTransferCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the transfer list. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classFileTransfer.html">FileTransfer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#aa05b78a7cd83387e58d08b463268a4bb">getTransfer</a> (QString id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a transfer object with a given id. <a href="#aa05b78a7cd83387e58d08b463268a4bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a0d72c3c65be6dcbaea683e3019f930e8">cancelAllTransfers</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cancels all idle transfers. <a href="#a0d72c3c65be6dcbaea683e3019f930e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a6a920922327d51ffa0bab686ad8bdf70">updateStatus</a> (QString id, unsigned long transferred, unsigned long totalSize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Updates the file transfer statistics of a <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object. <a href="#a6a920922327d51ffa0bab686ad8bdf70"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a38b007b915766aa77e9e29e05ea8bd6a">pauseProcessing</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pauses all file transfer processing. <a href="#a38b007b915766aa77e9e29e05ea8bd6a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a2651f7a2fffd03a606441118cda14159">resumeProcessing</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Resumes file transfer processing. <a href="#a2651f7a2fffd03a606441118cda14159"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46a19ec5aa8cef69d7fa43de260efe6f"></a><!-- doxytag: member="FileTransferList::instance" ref="a46a19ec5aa8cef69d7fa43de260efe6f" args="()" -->
static <a class="el" href="classFileTransferList.html">FileTransferList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a46a19ec5aa8cef69d7fa43de260efe6f">instance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the global <a class="el" href="classFileTransferList.html" title="Maintains a global file transfer processing list.">FileTransferList</a> instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d134827268a8652edb1272899ed6177"></a><!-- doxytag: member="FileTransferList::drop" ref="a4d134827268a8652edb1272899ed6177" args="()" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTransferList.html#a4d134827268a8652edb1272899ed6177">drop</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shuts down the global <a class="el" href="classFileTransferList.html" title="Maintains a global file transfer processing list.">FileTransferList</a> instance. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Maintains a global file transfer processing list. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0d72c3c65be6dcbaea683e3019f930e8"></a><!-- doxytag: member="FileTransferList::cancelAllTransfers" ref="a0d72c3c65be6dcbaea683e3019f930e8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransferList::cancelAllTransfers </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancels all idle transfers. </p>
<p>Due to limitiations in the current ARC API active transfers cannot be cancelled. Idle transfers are removed and destroyed from the list. </p>
</div>
</div>
<a class="anchor" id="aa05b78a7cd83387e58d08b463268a4bb"></a><!-- doxytag: member="FileTransferList::getTransfer" ref="aa05b78a7cd83387e58d08b463268a4bb" args="(QString id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFileTransfer.html">FileTransfer</a> * FileTransferList::getTransfer </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a transfer object with a given id. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>string representing the <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a valid FilaTransfer object if the id of the <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object is found, otherwise return a null object. </dd></dl>
</div>
</div>
<a class="anchor" id="a1e3efea6feca070a33cfa06c562db4ee"></a><!-- doxytag: member="FileTransferList::getTransfer" ref="a1e3efea6feca070a33cfa06c562db4ee" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classFileTransfer.html">FileTransfer</a> * FileTransferList::getTransfer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object from the list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>is the position in the list. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a valid <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object. If i is outside the list a null pointer is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="a38b007b915766aa77e9e29e05ea8bd6a"></a><!-- doxytag: member="FileTransferList::pauseProcessing" ref="a38b007b915766aa77e9e29e05ea8bd6a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransferList::pauseProcessing </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pauses all file transfer processing. </p>
<p>This method pauses transfer processing by pausing the <a class="el" href="classFileTransferProcessingThread.html" title="Thread class for driving the FileTransferList.">FileTransferProcessingThread</a> thread. Active file processing tasks can't be paused. </p>
</div>
</div>
<a class="anchor" id="a92ad0c960ff3a7d3a37a28bcd8dd0bbb"></a><!-- doxytag: member="FileTransferList::processTransfers" ref="a92ad0c960ff3a7d3a37a28bcd8dd0bbb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransferList::processTransfers </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Drives the file transfer processing. </p>
<p>This method checks for idle file transfer objects. If there are slots available, idle tasks are executed. The method is called by the <a class="el" href="classFileTransferProcessingThread.html" title="Thread class for driving the FileTransferList.">FileTransferProcessingThread</a>. </p>
</div>
</div>
<a class="anchor" id="a2651f7a2fffd03a606441118cda14159"></a><!-- doxytag: member="FileTransferList::resumeProcessing" ref="a2651f7a2fffd03a606441118cda14159" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransferList::resumeProcessing </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resumes file transfer processing. </p>
<p>Resumes file transfer processing by resuming the <a class="el" href="classFileTransferProcessingThread.html" title="Thread class for driving the FileTransferList.">FileTransferProcessingThread</a> thread. </p>
</div>
</div>
<a class="anchor" id="a6a920922327d51ffa0bab686ad8bdf70"></a><!-- doxytag: member="FileTransferList::updateStatus" ref="a6a920922327d51ffa0bab686ad8bdf70" args="(QString id, unsigned long transferred, unsigned long totalSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FileTransferList::updateStatus </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>Updates the file transfer statistics of a <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object. </p>
<p>This method is called from the ARC progress callbacks for updating file transfer status. The method is public to be able to be accessed from a static callback and should not be called directly. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>of <a class="el" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>transferred</em> </td><td>currently transferred bytes. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>totalSize</em> </td><td>total size of transfer. </td></tr>
</table>
</dd>
</dl>
</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="filetransferlist_8h_source.html">filetransferlist.h</a></li>
<li>/home/jonas/Development/arc-gui-clients/src/arcstorage-ui/filetransferlist.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>
|
