/usr/include/cupt/download/progress.hpp is in libcupt3-dev 2.6.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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | /**************************************************************************
* Copyright (C) 2010 by Eugene V. Lyubimkin *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License *
* (version 3 or above) as published by the Free Software Foundation. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU GPL *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA *
**************************************************************************/
#ifndef CUPT_DOWNLOAD_PROGRESS_SEEN
#define CUPT_DOWNLOAD_PROGRESS_SEEN
/// @file
#include <map>
#include <cupt/common.hpp>
namespace cupt {
namespace internal {
class ProgressImpl;
}
namespace download {
/// download progress meter
class CUPT_API Progress
{
internal::ProgressImpl* __impl;
public:
/// download element
struct DownloadRecord
{
size_t number; ///< unique number
size_t downloadedSize; ///< already downloaded amount of bytes
size_t size; ///< expected file size, @c -1 if unknown
enum class Phase
{
Planned, ///< not started yet, @a number is not initialized
Started, ///< started, @a number is now holding a valid value
Postprocessed ///< network actions finished, result is being postprocessed
} phase;
float sizeScaleFactor;
DownloadRecord();
};
protected:
/**
* @param uri
* @return long alias for @a uri if it was specified, @a uri otherwise
*/
string getLongAliasForUri(const string& uri) const;
/**
* @param uri
* @return short alias for @a uri if it was specified, @a uri otherwise
*/
string getShortAliasForUri(const string& uri) const;
/**
* @see markAsOptional
*/
bool isOptional(const string& uri) const;
/**
* Gets current downloads.
*
* @return map of uris to download records.
*/
const std::map< string, DownloadRecord >& getDownloadRecords() const;
/**
* @return the sum of already done downloads in the current session plus
* the sum of downloaded parts of running downloads
*/
uint64_t getOverallDownloadedSize() const;
/**
* Overall estimated size is guaranteed to be not less than @ref
* getOverallDownloadedSize.
*
* @return total estimated size counting both done and running downloads
*/
uint64_t getOverallEstimatedSize() const;
/**
* @return total byte count of all data chunks fetched from the network (or
* its equivalent)
*/
uint64_t getOverallFetchedSize() const;
/**
* @return number of seconds since the start of the download session
*/
size_t getOverallDownloadTime() const;
/**
* @return number of seconds, estimated time to finish since the start of
* the download session
*/
size_t getOverallEstimatedTime() const;
/**
* @return current download speed in bytes/second
*/
size_t getDownloadSpeed() const;
/**
* This hook is called when new download starts.
*
* @param uri
* @param downloadRecord
*/
virtual void newDownloadHook(const string& uri, const DownloadRecord& downloadRecord);
/**
* This hook is called when some download is finished.
*
* @param uri
* @param result download exit code, empty string is success, non-empty
* string is human-readable download error message
*/
virtual void finishedDownloadHook(const string& uri, const string& result);
/**
* This hook is called whenever some download information is updated
* (including being called after @ref newDownloadHook and @ref
* finishedDownloadHook).
*
* @param immediate is update important or not; examples of important
* updates: new download, finished download, changes of a download state;
* examples of unimportant updates: number of download bytes changes for
* some download
*/
virtual void updateHook(bool immediate);
/**
* This hook is called before the end of the download session.
*/
virtual void finishHook();
public:
/// constructor
Progress();
/// amount of seconds considered while calculating a download speed
/**
* Default: 16
*/
static float speedCalculatingAccuracy;
/// sets a short alias for URI
/**
* @param uri
* @param alias short alias
*/
void setShortAliasForUri(const string& uri, const string& alias);
/// sets a long alias for URI
/**
* @param uri
* @param alias long alias
*/
void setLongAliasForUri(const string& uri, const string& alias);
/**
* Notify that a failure to download @a uri is not an error.
* @param uri
*/
void markAsOptional(const string& uri);
/// @cond
CUPT_LOCAL void progress(const vector< string >& params);
/// @endcond
/// destructor
virtual ~Progress();
};
}
}
#endif
|