1
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml">
5
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6
<title>ARC Graphical Clients: /home/jonas/Development/arc-gui-clients/src/arcstorage-ui/filetransfer.h Source File</title>
7
<link href="tabs.css" rel="stylesheet" type="text/css"/>
8
<link href="search/search.css" rel="stylesheet" type="text/css"/>
9
<script type="text/javaScript" src="search/search.js"></script>
10
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
12
<body onload='searchBox.OnSelectItem(0);'>
13
<!-- Generated by Doxygen 1.6.1 -->
14
<script type="text/javascript"><!--
15
var searchBox = new SearchBox("searchBox", "search",false,'Search');
17
<div class="navigation" id="top">
20
<li><a href="index.html"><span>Main Page</span></a></li>
21
<li><a href="annotated.html"><span>Classes</span></a></li>
22
<li class="current"><a href="files.html"><span>Files</span></a></li>
24
<div id="MSearchBox" class="MSearchBoxInactive">
25
<img id="MSearchSelect" src="search/search.png"
26
onmouseover="return searchBox.OnSearchSelectShow()"
27
onmouseout="return searchBox.OnSearchSelectHide()"
29
<input type="text" id="MSearchField" value="Search" accesskey="S"
30
onfocus="searchBox.OnSearchFieldFocus(true)"
31
onblur="searchBox.OnSearchFieldFocus(false)"
32
onkeyup="searchBox.OnSearchFieldChange(event)"/>
33
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
40
<li><a href="files.html"><span>File List</span></a></li>
43
<h1>/home/jonas/Development/arc-gui-clients/src/arcstorage-ui/filetransfer.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef FILETRANSFER_H</span>
44
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define FILETRANSFER_H</span>
45
<a name="l00003"></a>00003 <span class="preprocessor"></span>
46
<a name="l00004"></a>00004 <span class="preprocessor">#include <iostream></span>
47
<a name="l00005"></a>00005 <span class="preprocessor">#include <string></span>
48
<a name="l00006"></a>00006
49
<a name="l00007"></a>00007 <span class="preprocessor">#include "arc-gui-config.h"</span>
50
<a name="l00008"></a>00008 <span class="preprocessor">#include <arc/Thread.h></span>
51
<a name="l00009"></a>00009
52
<a name="l00010"></a>00010 <span class="preprocessor">#include <arc/ArcLocation.h></span>
53
<a name="l00011"></a>00011 <span class="preprocessor">#include <arc/GUID.h></span>
54
<a name="l00012"></a>00012 <span class="preprocessor">#include <arc/Logger.h></span>
55
<a name="l00013"></a>00013 <span class="preprocessor">#include <arc/StringConv.h></span>
56
<a name="l00014"></a>00014 <span class="preprocessor">#include <arc/URL.h></span>
57
<a name="l00015"></a>00015 <span class="preprocessor">#include <arc/User.h></span>
58
<a name="l00016"></a>00016 <span class="preprocessor">#include <arc/UserConfig.h></span>
59
<a name="l00017"></a>00017 <span class="preprocessor">#include <arc/credential/Credential.h></span>
60
<a name="l00018"></a>00018 <span class="preprocessor">#include <arc/data/FileCache.h></span>
61
<a name="l00019"></a>00019 <span class="preprocessor">#include <arc/data/DataHandle.h></span>
62
<a name="l00020"></a>00020 <span class="preprocessor">#include <arc/data/DataMover.h></span>
63
<a name="l00021"></a>00021 <span class="preprocessor">#include <arc/data/URLMap.h></span>
64
<a name="l00022"></a>00022 <span class="preprocessor">#include <arc/OptionParser.h></span>
65
<a name="l00023"></a>00023
66
<a name="l00024"></a>00024 <span class="preprocessor">#include <QObject></span>
67
<a name="l00025"></a>00025 <span class="preprocessor">#include <QString></span>
68
<a name="l00026"></a>00026
69
<a name="l00028"></a>00028 <span class="keyword">enum</span> TTransferState { TS_IDLE,
70
<a name="l00029"></a>00029 TS_EXECUTED,
71
<a name="l00030"></a>00030 TS_FAILED,
72
<a name="l00031"></a>00031 TS_COMPLETED
73
<a name="l00032"></a>00032 };
74
<a name="l00033"></a>00033
75
<a name="l00035"></a><a class="code" href="classFileTransfer.html">00035</a> <span class="keyword">class </span><a class="code" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a> : <span class="keyword">public</span> QObject
76
<a name="l00036"></a>00036 {
77
<a name="l00037"></a>00037 Q_OBJECT
78
<a name="l00038"></a>00038 <span class="keyword">private</span>:
79
<a name="l00039"></a>00039 std::string m_id;
80
<a name="l00040"></a>00040 TTransferState m_transferState;
81
<a name="l00041"></a>00041 <span class="keywordtype">int</span> m_timeout;
82
<a name="l00042"></a>00042 <span class="keywordtype">int</span> m_retries;
83
<a name="l00043"></a>00043 <span class="keywordtype">bool</span> m_secure;
84
<a name="l00044"></a>00044 <span class="keywordtype">bool</span> m_passive;
85
<a name="l00045"></a>00045 <span class="keywordtype">bool</span> m_notpassive;
86
<a name="l00046"></a>00046 <span class="keywordtype">bool</span> m_force;
87
<a name="l00047"></a>00047 <span class="keywordtype">bool</span> m_verbose;
88
<a name="l00048"></a>00048 <span class="keywordtype">bool</span> m_nocopy;
89
<a name="l00049"></a>00049 <span class="keywordtype">int</span> m_recursion;
90
<a name="l00050"></a>00050 <span class="keywordtype">bool</span> m_completed;
91
<a name="l00051"></a>00051 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_transferred;
92
<a name="l00052"></a>00052 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_totalSize;
93
<a name="l00053"></a>00053
94
<a name="l00054"></a>00054 Arc::URL m_sourceUrl;
95
<a name="l00055"></a>00055 Arc::URL m_destUrl;
96
<a name="l00056"></a>00056 Arc::DataHandle m_sourceHandle;
97
<a name="l00057"></a>00057 Arc::DataHandle m_destHandle;
98
<a name="l00058"></a>00058 Arc::DataMover* m_mover;
99
<a name="l00059"></a>00059 Arc::FileCache* m_cache;
100
<a name="l00060"></a>00060 Arc::URLMap* m_urlMap;
101
<a name="l00061"></a>00061 Arc::UserConfig* m_config;
102
<a name="l00062"></a>00062 Arc::DataStatus m_status;
103
<a name="l00063"></a>00063 Arc::SimpleCondition m_cond;
104
<a name="l00064"></a>00064 <span class="keyword">public</span>:
105
<a name="l00066"></a>00066
106
<a name="l00074"></a>00074 <a class="code" href="classFileTransfer.html#a0f2aa2aef9675817ccdffb5595b0d1eb" title="Create a file transfer object.">FileTransfer</a>(<span class="keyword">const</span> std::string& source_str, <span class="keyword">const</span> std::string& destination_str, Arc::UserConfig& usercfg);
107
<a name="l00075"></a>00075 <span class="keyword">virtual</span> ~<a class="code" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a>();
108
<a name="l00076"></a>00076
109
<a name="l00078"></a>00078 TTransferState <a class="code" href="classFileTransfer.html#a7171fa5cd1e29c76bae7bb3810e5e082" title="Return the current transfer state.">transferState</a>();
110
<a name="l00079"></a>00079
111
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> <a class="code" href="classFileTransfer.html#afba57e1d84467e85cd60c891294b21aa" title="Start the actual file transfer.">execute</a>();
112
<a name="l00082"></a>00082
113
<a name="l00084"></a>00084 <span class="keywordtype">void</span> <a class="code" href="classFileTransfer.html#a4fe970a33029d645352268687e33dd63" title="Wait for the file transfer to complete.">wait</a>();
114
<a name="l00085"></a>00085
115
<a name="l00087"></a>00087 Arc::DataStatus <a class="code" href="classFileTransfer.html#ad18f4f66878880fa74a5ebcc834a4130" title="Return the ARC transfer status.">status</a>();
116
<a name="l00088"></a>00088
117
<a name="l00090"></a>00090
118
<a name="l00094"></a>00094 <span class="keywordtype">void</span> <a class="code" href="classFileTransfer.html#a77255b1ff5556196fbc6ef13d1d3625f" title="Routine called by the ARC callbacks to indicate a failed/completed file transfer...">completed</a>(Arc::DataStatus res, std::string error);
119
<a name="l00095"></a>00095
120
<a name="l00097"></a>00097
121
<a name="l00101"></a>00101 <span class="keywordtype">void</span> <a class="code" href="classFileTransfer.html#a4458e84260463d51b57da41a71edc7eb" title="Cancel the transfer.">cancel</a>();
122
<a name="l00102"></a>00102
123
<a name="l00104"></a>00104 <span class="keywordtype">bool</span> <a class="code" href="classFileTransfer.html#adc1f397e7eadcd0acb6a1a1111e7cce7" title="Returns true if transfer is completed.">isCompleted</a>();
124
<a name="l00105"></a>00105
125
<a name="l00107"></a>00107 QString <a class="code" href="classFileTransfer.html#a28f7e04f54b3466005fc8d5c4a3d490b" title="Return current transfer id.">id</a>();
126
<a name="l00108"></a>00108
127
<a name="l00110"></a>00110 QString <a class="code" href="classFileTransfer.html#a44d03a37fa86e5edeb531754799eafc2" title="Return source URL.">sourceUrl</a>();
128
<a name="l00111"></a>00111
129
<a name="l00113"></a>00113 QString <a class="code" href="classFileTransfer.html#a3cfd2be9e2ed533aef999f9794a208c8" title="Return destination URL.">destUrl</a>();
130
<a name="l00114"></a>00114
131
<a name="l00116"></a>00116
132
<a name="l00120"></a>00120 <span class="keywordtype">void</span> <a class="code" href="classFileTransfer.html#a4a0b8f2cda0addd90c1411adf31bf5b7" title="Updated the current transfer statistics.">updateTransferStatus</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> transferred, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> totalSize);
133
<a name="l00121"></a>00121
134
<a name="l00123"></a>00123 <span class="keywordtype">void</span> <a class="code" href="classFileTransfer.html#a106871aa5f01c5a39498404c35fa2733" title="Return current transfer statistics.">getTransferStatus</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>& transferred, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>& totalSize);
135
<a name="l00124"></a>00124
136
<a name="l00125"></a>00125 Q_SIGNALS:
137
<a name="l00126"></a>00126
138
<a name="l00128"></a>00128
139
<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="classFileTransfer.html#a27387942c6eaf287746a491f546791ff" title="Signal for updating transfer status.">onProgress</a>(<a class="code" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a>* fileTransfer, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> bytesTransferred, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> bytesTotal);
140
<a name="l00136"></a>00136 <span class="keywordtype">void</span> onCompleted(<a class="code" href="classFileTransfer.html" title="Represents a single data transfer from one url to another.">FileTransfer</a>* fileTransfer, <span class="keywordtype">bool</span> success, QString error);
141
<a name="l00137"></a>00137 };
142
<a name="l00138"></a>00138
143
<a name="l00139"></a>00139 <span class="preprocessor">#endif // FILETRANSFER_H</span>
145
<!--- window showing the filter options -->
146
<div id="MSearchSelectWindow"
147
onmouseover="return searchBox.OnSearchSelectShow()"
148
onmouseout="return searchBox.OnSearchSelectHide()"
149
onkeydown="return searchBox.OnSearchSelectKey(event)">
150
<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>
152
<!-- iframe showing the search results (closed by default) -->
153
<div id="MSearchResultsWindow">
154
<iframe src="" frameborder="0"
155
name="MSearchResults" id="MSearchResults">
159
<hr size="1"/><address style="text-align: right;"><small>Generated on 19 Feb 2013 for ARC Graphical Clients by
160
<a href="http://www.doxygen.org/index.html">
161
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
added
removed
docs/doxygen/output/html/filetransfer_8h_source.html
