summaryrefslogtreecommitdiffstats
path: root/doxygen/html/downloadmanager_8h_source.html
blob: 1eab2bb188eab871fef8cecd7e8ebe668efc57c5 (plain) (blame)
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
<!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>ndgui/NetworkDiscovery: /home/niklas/workspace/fbgui/src/downloadmanager.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">ndgui/NetworkDiscovery</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</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 id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.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)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('downloadmanager_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>/home/niklas/workspace/fbgui/src/downloadmanager.h</h1>  </div>
</div>
<div class="contents">
<a href="downloadmanager_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2010,2011 - RZ Uni Freiburg</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2010,2011 - OpenSLX Project</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This program/file is free software distributed under the GPL version 2.</span>
<a name="l00006"></a>00006 <span class="comment"> * See http://openslx.org/COPYING</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * If you have any feedback please consult http://openslx.org/feedback and</span>
<a name="l00009"></a>00009 <span class="comment"> * send your feedback to feedback@openslx.org</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * General information about OpenSLX can be found under http://openslx.org</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> *         Class managing download requests:</span>
<a name="l00015"></a>00015 <span class="comment"> *              - provides queueing functionality</span>
<a name="l00016"></a>00016 <span class="comment"> *              - static info: filename, filesize</span>
<a name="l00017"></a>00017 <span class="comment"> *              - dynamic info: download progress, current speed</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef DOWNLOADMANAGER_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define DOWNLOADMANAGER_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &quot;<a class="code" href="fbgui_8h.html">fbgui.h</a>&quot;</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="keyword">extern</span> <span class="keywordtype">bool</span> <a class="code" href="downloadmanager_8h.html#a398527b3e9e358c345c5047b16871957">debug</a>;
<a name="l00027"></a>00027 <span class="keyword">extern</span> QUrl <a class="code" href="downloadmanager_8h.html#a234e8a60f8c04f267847d0f548e48cb9">baseURL</a>;
<a name="l00028"></a>00028 <span class="keyword">extern</span> QString <a class="code" href="downloadmanager_8h.html#a77498c74d71edea0b1fddec0565ca859">binPath</a>;
<a name="l00029"></a>00029 <span class="keyword">extern</span> QString <a class="code" href="downloadmanager_8h.html#aa99ae0a965d4bde3989d259fadc4f0ec">downloadPath</a>;
<a name="l00030"></a>00030 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="downloadmanager_8h.html#afb7bae46ad8e23553477b181275e66fa">updateInterval</a>;
<a name="l00031"></a>00031 
<a name="l00032"></a><a class="code" href="class_download_manager.html">00032</a> <span class="keyword">class </span><a class="code" href="class_download_manager.html">DownloadManager</a>: <span class="keyword">public</span> QObject {
<a name="l00033"></a>00033 Q_OBJECT
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a>00036    <a class="code" href="class_download_manager.html#af9b8808c39d0e30a402666d4e578e70e">DownloadManager</a>();
<a name="l00037"></a>00037    <a class="code" href="class_download_manager.html#abb67275a951d706a3108a0d307ea9113">~DownloadManager</a>();
<a name="l00038"></a><a class="code" href="class_download_manager.html#a6c8af4bf075bcc5372860dbbd73bc131">00038</a>    QTime <a class="code" href="class_download_manager.html#a6c8af4bf075bcc5372860dbbd73bc131">time</a>;
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">private</span>:
<a name="l00041"></a>00041    <span class="comment">// checks for valid download directory, ran once in constructor</span>
<a name="l00042"></a>00042    <span class="keywordtype">void</span> checkDownloadDirectory();
<a name="l00043"></a>00043    <span class="comment">// private control function for queueing mechanism.</span>
<a name="l00044"></a>00044    <span class="keywordtype">void</span> processDownloadRequest(<span class="keyword">const</span> QUrl&amp; url);
<a name="l00045"></a>00045 
<a name="l00046"></a>00046    <span class="comment">// base objects for downloading</span>
<a name="l00047"></a>00047    QNetworkAccessManager* _qnam;
<a name="l00048"></a>00048    QQueue&lt;QUrl&gt; _downloadQueue;
<a name="l00049"></a>00049    QNetworkReply* _currentDownload;
<a name="l00050"></a>00050    QFile _outfile;
<a name="l00051"></a>00051    QDir _downloadDir;
<a name="l00052"></a>00052    <span class="comment">// download progress variables</span>
<a name="l00053"></a>00053    <span class="keywordtype">int</span> _currentProgress, _lastProgress;
<a name="l00054"></a>00054    <span class="comment">// download in progress flag</span>
<a name="l00055"></a>00055    <span class="keywordtype">bool</span> _dip;
<a name="l00056"></a>00056    <span class="comment">// static counter</span>
<a name="l00057"></a>00057    <span class="keyword">static</span> <span class="keywordtype">int</span> _downloaded;
<a name="l00058"></a>00058 
<a name="l00059"></a>00059 signals:
<a name="l00060"></a>00060    <span class="comment">// notify sends a message to the javascript interface to be evaluated there</span>
<a name="l00061"></a>00061    <span class="keywordtype">void</span> <a class="code" href="class_download_manager.html#a4c410f1ac445d93b4251c70a92f3fd7e">notify</a>(<span class="keyword">const</span> QString&amp; msg);
<a name="l00062"></a>00062    <span class="comment">// downloadInfo sends static information (name, size) to the interface.</span>
<a name="l00063"></a>00063    <span class="keywordtype">void</span> <a class="code" href="class_download_manager.html#adc2f6c143c220743395b8e618544bfbb">downloadInfo</a>(<span class="keyword">const</span> QString&amp; filename, <span class="keyword">const</span> <span class="keywordtype">double</span>&amp; filesize);
<a name="l00064"></a>00064    <span class="comment">// updateProgress sends download progress information to the interface.</span>
<a name="l00065"></a>00065    <span class="keywordtype">void</span> <a class="code" href="class_download_manager.html#aacb3a486aac7b6027acebae08912f5e9">updateProgress</a>(<span class="keyword">const</span> <span class="keywordtype">int</span>&amp; percent, <span class="keyword">const</span> <span class="keywordtype">double</span>&amp; speed, <span class="keyword">const</span> QString&amp; unit);
<a name="l00066"></a>00066    <span class="comment">// signal emitted when download queue is empty.</span>
<a name="l00067"></a>00067    <span class="keywordtype">void</span> <a class="code" href="class_download_manager.html#aae1d90600db32b6d877546d89a140657">downloadQueueEmpty</a>();
<a name="l00068"></a>00068 
<a name="l00069"></a>00069 <span class="keyword">public</span> slots:
<a name="l00070"></a>00070    <span class="comment">// public slots to receive download requests.</span>
<a name="l00071"></a>00071    <span class="keywordtype">void</span> <a class="code" href="class_download_manager.html#a22a6840285339eccfcee5aea23fa5bde">downloadFile</a>(<span class="keyword">const</span> QUrl&amp; fileUrl);
<a name="l00072"></a>00072    <span class="comment">// convenience function</span>
<a name="l00073"></a>00073    <span class="keywordtype">void</span> <a class="code" href="class_download_manager.html#a22a6840285339eccfcee5aea23fa5bde">downloadFile</a>(<span class="keyword">const</span> QString&amp; fileUrl);
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 <span class="keyword">private</span> slots:
<a name="l00076"></a>00076    <span class="comment">// private slots to manage the downloading process</span>
<a name="l00077"></a>00077    <span class="keywordtype">void</span> startNextDownload();
<a name="l00078"></a>00078    <span class="keywordtype">void</span> processMetaInfo();
<a name="l00079"></a>00079    <span class="keywordtype">void</span> downloadReady();
<a name="l00080"></a>00080    <span class="keywordtype">void</span> downloadProgress(qint64 bytesIn, qint64 bytesTotal);
<a name="l00081"></a>00081    <span class="keywordtype">void</span> downloadFinished();
<a name="l00082"></a>00082 };
<a name="l00083"></a>00083 
<a name="l00084"></a>00084 <span class="preprocessor">#endif // DOWNLOADMANAGER_H</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="downloadmanager_8h.html">downloadmanager.h</a>      </li>
      <li class="footer">Generated on Wed Nov 9 2011 15:35:22 for ndgui/NetworkDiscovery by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


</body>
</html>