File: filetransfer_8h_source.html

package info (click to toggle)
arc-gui-clients 0.4.6-7
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 25,484 kB
  • sloc: cpp: 11,077; python: 181; perl: 171; pascal: 165; ansic: 12; makefile: 7
file content (163 lines) | stat: -rw-r--r-- 13,102 bytes parent folder | download | duplicates (3)
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
<!-- 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: /home/jonas/Development/arc-gui-clients/src/arcstorage-ui/filetransfer.h Source File</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&nbsp;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><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="files.html"><span>File&nbsp;List</span></a></li>
    </ul>
  </div>
<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>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define FILETRANSFER_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &lt;iostream&gt;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00006"></a>00006 
<a name="l00007"></a>00007 <span class="preprocessor">#include &quot;arc-gui-config.h&quot;</span>
<a name="l00008"></a>00008 <span class="preprocessor">#include &lt;arc/Thread.h&gt;</span>
<a name="l00009"></a>00009 
<a name="l00010"></a>00010 <span class="preprocessor">#include &lt;arc/ArcLocation.h&gt;</span>
<a name="l00011"></a>00011 <span class="preprocessor">#include &lt;arc/GUID.h&gt;</span>
<a name="l00012"></a>00012 <span class="preprocessor">#include &lt;arc/Logger.h&gt;</span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &lt;arc/StringConv.h&gt;</span>
<a name="l00014"></a>00014 <span class="preprocessor">#include &lt;arc/URL.h&gt;</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;arc/User.h&gt;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;arc/UserConfig.h&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;arc/credential/Credential.h&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;arc/data/FileCache.h&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;arc/data/DataHandle.h&gt;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &lt;arc/data/DataMover.h&gt;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &lt;arc/data/URLMap.h&gt;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &lt;arc/OptionParser.h&gt;</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;QObject&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QString&gt;</span>
<a name="l00026"></a>00026 
<a name="l00028"></a>00028 <span class="keyword">enum</span> TTransferState { TS_IDLE,     
<a name="l00029"></a>00029                       TS_EXECUTED, 
<a name="l00030"></a>00030                       TS_FAILED,   
<a name="l00031"></a>00031                       TS_COMPLETED 
<a name="l00032"></a>00032                     };
<a name="l00033"></a>00033 
<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
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037     Q_OBJECT
<a name="l00038"></a>00038 <span class="keyword">private</span>:
<a name="l00039"></a>00039     std::string m_id;
<a name="l00040"></a>00040     TTransferState m_transferState;
<a name="l00041"></a>00041     <span class="keywordtype">int</span> m_timeout;
<a name="l00042"></a>00042     <span class="keywordtype">int</span> m_retries;
<a name="l00043"></a>00043     <span class="keywordtype">bool</span> m_secure;
<a name="l00044"></a>00044     <span class="keywordtype">bool</span> m_passive;
<a name="l00045"></a>00045     <span class="keywordtype">bool</span> m_notpassive;
<a name="l00046"></a>00046     <span class="keywordtype">bool</span> m_force;
<a name="l00047"></a>00047     <span class="keywordtype">bool</span> m_verbose;
<a name="l00048"></a>00048     <span class="keywordtype">bool</span> m_nocopy;
<a name="l00049"></a>00049     <span class="keywordtype">int</span> m_recursion;
<a name="l00050"></a>00050     <span class="keywordtype">bool</span> m_completed;
<a name="l00051"></a>00051     <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_transferred;
<a name="l00052"></a>00052     <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_totalSize;
<a name="l00053"></a>00053 
<a name="l00054"></a>00054     Arc::URL m_sourceUrl;
<a name="l00055"></a>00055     Arc::URL m_destUrl;
<a name="l00056"></a>00056     Arc::DataHandle m_sourceHandle;
<a name="l00057"></a>00057     Arc::DataHandle m_destHandle;
<a name="l00058"></a>00058     Arc::DataMover* m_mover;
<a name="l00059"></a>00059     Arc::FileCache* m_cache;
<a name="l00060"></a>00060     Arc::URLMap* m_urlMap;
<a name="l00061"></a>00061     Arc::UserConfig* m_config;
<a name="l00062"></a>00062     Arc::DataStatus m_status;
<a name="l00063"></a>00063     Arc::SimpleCondition m_cond;
<a name="l00064"></a>00064 <span class="keyword">public</span>:
<a name="l00066"></a>00066 
<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&amp; source_str, <span class="keyword">const</span> std::string&amp; destination_str, Arc::UserConfig&amp; usercfg);
<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>();
<a name="l00076"></a>00076 
<a name="l00078"></a>00078     TTransferState <a class="code" href="classFileTransfer.html#a7171fa5cd1e29c76bae7bb3810e5e082" title="Return the current transfer state.">transferState</a>();
<a name="l00079"></a>00079 
<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>();
<a name="l00082"></a>00082 
<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>();
<a name="l00085"></a>00085 
<a name="l00087"></a>00087     Arc::DataStatus <a class="code" href="classFileTransfer.html#ad18f4f66878880fa74a5ebcc834a4130" title="Return the ARC transfer status.">status</a>();
<a name="l00088"></a>00088 
<a name="l00090"></a>00090 
<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);
<a name="l00095"></a>00095 
<a name="l00097"></a>00097 
<a name="l00101"></a>00101     <span class="keywordtype">void</span> <a class="code" href="classFileTransfer.html#a4458e84260463d51b57da41a71edc7eb" title="Cancel the transfer.">cancel</a>();
<a name="l00102"></a>00102 
<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>();
<a name="l00105"></a>00105 
<a name="l00107"></a>00107     QString <a class="code" href="classFileTransfer.html#a28f7e04f54b3466005fc8d5c4a3d490b" title="Return current transfer id.">id</a>();
<a name="l00108"></a>00108 
<a name="l00110"></a>00110     QString <a class="code" href="classFileTransfer.html#a44d03a37fa86e5edeb531754799eafc2" title="Return source URL.">sourceUrl</a>();
<a name="l00111"></a>00111 
<a name="l00113"></a>00113     QString <a class="code" href="classFileTransfer.html#a3cfd2be9e2ed533aef999f9794a208c8" title="Return destination URL.">destUrl</a>();
<a name="l00114"></a>00114 
<a name="l00116"></a>00116 
<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);
<a name="l00121"></a>00121 
<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>&amp; transferred, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>&amp; totalSize);
<a name="l00124"></a>00124 
<a name="l00125"></a>00125 Q_SIGNALS:
<a name="l00126"></a>00126 
<a name="l00128"></a>00128 
<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);
<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);
<a name="l00137"></a>00137 };
<a name="l00138"></a>00138 
<a name="l00139"></a>00139 <span class="preprocessor">#endif // FILETRANSFER_H</span>
</pre></div></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">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>