/usr/share/doc/libcupt3-doc/html/progress_8hpp_source.html is in libcupt3-doc 2.8.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>Cupt: cupt/download/progress.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Cupt
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_624754ba24599b6ed9aabda614b55fb5.html">cupt</a></li><li class="navelem"><a class="el" href="dir_6dadd32de322c2765e58b8fe83012d7b.html">download</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">progress.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="progress_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**************************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">* Copyright (C) 2010 by Eugene V. Lyubimkin *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* This program is free software; you can redistribute it and/or modify *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* it under the terms of the GNU General Public License *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* (version 3 or above) as published by the Free Software Foundation. *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* This program is distributed in the hope that it will be useful, *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* GNU General Public License for more details. *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* You should have received a copy of the GNU GPL *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* along with this program; if not, write to the *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">* Free Software Foundation, Inc., *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">**************************************************************************/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef CUPT_DOWNLOAD_PROGRESS_SEEN</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define CUPT_DOWNLOAD_PROGRESS_SEEN</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <map></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <<a class="code" href="common_8hpp.html">cupt/common.hpp</a>></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespacecupt.html">cupt</a> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>ProgressImpl;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> }</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>download {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classcupt_1_1download_1_1Progress.html"> 38</a></span> <span class="keyword">class </span>CUPT_API <a class="code" href="classcupt_1_1download_1_1Progress.html">Progress</a></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  internal::ProgressImpl* __impl;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html"> 43</a></span>  <span class="keyword">struct </span><a class="code" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html">DownloadRecord</a></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#acccaa3382b4cc814bebb2be1e0a63f81"> 45</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#acccaa3382b4cc814bebb2be1e0a63f81">number</a>; </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#ab5dc0fe253a5f68ec59462ed29b50239"> 46</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#ab5dc0fe253a5f68ec59462ed29b50239">downloadedSize</a>; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#a041ca566796e408c256ea4f510c2cde9"> 47</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#a041ca566796e408c256ea4f510c2cde9">size</a>; </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#a7a9baf37cf506a7dcb4b189ec615beae"> 48</a></span>  <span class="keyword">enum class</span> <a class="code" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#a7a9baf37cf506a7dcb4b189ec615beae">Phase</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  Planned, </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  Started, </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  Postprocessed </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  } phase;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">float</span> sizeScaleFactor;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html">DownloadRecord</a>();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  };</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">string</span> getLongAliasForUri(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">string</span> getShortAliasForUri(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> isOptional(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">const</span> std::map< string, DownloadRecord >& getDownloadRecords() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  uint64_t getOverallDownloadedSize() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  uint64_t getOverallEstimatedSize() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  uint64_t getOverallFetchedSize() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">size_t</span> getOverallDownloadTime() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">size_t</span> getOverallEstimatedTime() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">size_t</span> getDownloadSpeed() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> newDownloadHook(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri, <span class="keyword">const</span> DownloadRecord& downloadRecord);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> finishedDownloadHook(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri, <span class="keyword">const</span> <span class="keywordtype">string</span>& result);</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> updateHook(<span class="keywordtype">bool</span> immediate);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> finishHook();</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="classcupt_1_1download_1_1Progress.html">Progress</a>();</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="classcupt_1_1download_1_1Progress.html#acecd8ebfffe744c641f6a01c29e2b7e7"> 149</a></span>  <span class="keyword">static</span> <span class="keywordtype">float</span> <a class="code" href="classcupt_1_1download_1_1Progress.html#acecd8ebfffe744c641f6a01c29e2b7e7">speedCalculatingAccuracy</a>;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">void</span> setShortAliasForUri(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri, <span class="keyword">const</span> <span class="keywordtype">string</span>& alias);</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordtype">void</span> setLongAliasForUri(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri, <span class="keyword">const</span> <span class="keywordtype">string</span>& alias);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keywordtype">void</span> markAsOptional(<span class="keyword">const</span> <span class="keywordtype">string</span>& uri);</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  CUPT_LOCAL <span class="keywordtype">void</span> progress(<span class="keyword">const</span> vector< string >& params);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keyword">virtual</span> ~<a class="code" href="classcupt_1_1download_1_1Progress.html">Progress</a>();</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> };</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> }</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> }</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="ttc" id="structcupt_1_1download_1_1Progress_1_1DownloadRecord_html_acccaa3382b4cc814bebb2be1e0a63f81"><div class="ttname"><a href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#acccaa3382b4cc814bebb2be1e0a63f81">cupt::download::Progress::DownloadRecord::number</a></div><div class="ttdeci">size_t number</div><div class="ttdoc">unique number </div><div class="ttdef"><b>Definition:</b> progress.hpp:45</div></div>
<div class="ttc" id="structcupt_1_1download_1_1Progress_1_1DownloadRecord_html"><div class="ttname"><a href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html">cupt::download::Progress::DownloadRecord</a></div><div class="ttdoc">download element </div><div class="ttdef"><b>Definition:</b> progress.hpp:43</div></div>
<div class="ttc" id="classcupt_1_1download_1_1Progress_html"><div class="ttname"><a href="classcupt_1_1download_1_1Progress.html">cupt::download::Progress</a></div><div class="ttdoc">download progress meter </div><div class="ttdef"><b>Definition:</b> progress.hpp:38</div></div>
<div class="ttc" id="namespacecupt_html"><div class="ttname"><a href="namespacecupt.html">cupt</a></div><div class="ttdef"><b>Definition:</b> binarypackage.hpp:26</div></div>
<div class="ttc" id="common_8hpp_html"><div class="ttname"><a href="common_8hpp.html">common.hpp</a></div></div>
<div class="ttc" id="structcupt_1_1download_1_1Progress_1_1DownloadRecord_html_a041ca566796e408c256ea4f510c2cde9"><div class="ttname"><a href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#a041ca566796e408c256ea4f510c2cde9">cupt::download::Progress::DownloadRecord::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">expected file size, -1 if unknown </div><div class="ttdef"><b>Definition:</b> progress.hpp:47</div></div>
<div class="ttc" id="structcupt_1_1download_1_1Progress_1_1DownloadRecord_html_ab5dc0fe253a5f68ec59462ed29b50239"><div class="ttname"><a href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#ab5dc0fe253a5f68ec59462ed29b50239">cupt::download::Progress::DownloadRecord::downloadedSize</a></div><div class="ttdeci">size_t downloadedSize</div><div class="ttdoc">already downloaded amount of bytes </div><div class="ttdef"><b>Definition:</b> progress.hpp:46</div></div>
<div class="ttc" id="classcupt_1_1download_1_1Progress_html_acecd8ebfffe744c641f6a01c29e2b7e7"><div class="ttname"><a href="classcupt_1_1download_1_1Progress.html#acecd8ebfffe744c641f6a01c29e2b7e7">cupt::download::Progress::speedCalculatingAccuracy</a></div><div class="ttdeci">static float speedCalculatingAccuracy</div><div class="ttdoc">amount of seconds considered while calculating a download speed </div><div class="ttdef"><b>Definition:</b> progress.hpp:149</div></div>
<div class="ttc" id="structcupt_1_1download_1_1Progress_1_1DownloadRecord_html_a7a9baf37cf506a7dcb4b189ec615beae"><div class="ttname"><a href="structcupt_1_1download_1_1Progress_1_1DownloadRecord.html#a7a9baf37cf506a7dcb4b189ec615beae">cupt::download::Progress::DownloadRecord::Phase</a></div><div class="ttdeci">Phase</div><div class="ttdef"><b>Definition:</b> progress.hpp:48</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Oct 19 2014 18:02:59 for Cupt by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|