smallsolar/libkiwix
1
0
Fork 0
mirror of https://github.com/kiwix/libkiwix.git synced 2025-06-26 10:11:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove the default value of follow parameter in updateStatus.

Browse Source 
`false` is a pretty bad default value as most user want to track
the real download.

By removing the default value, we force user to make a choice.
We could have change the default value to true but it would have been
a silent API change and we don't want that.
This commit is contained in:
Matthieu Gautier
2023-02-07 11:25:34 +01:00
parent f239f2de18
commit 2c3b7409aa
2 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
include/downloader.h
View File

@ -71,14 +71,15 @@ class Download {
* - A first one to download the metadlink.
* - A second one to download the real file.
*
* By default, `Download` track only the first download. So status may appear
* as COMPLETE even if the real file downloading is still running.
* By passing true to follow, `Dowload` will detect that and will track the
* second download instead.
* If `follow` is true, updateStatus tries to detect that and tracks
* the second download when the first one is finished.
* By passing false to `follow`, `Download` will only track the first download.
*
* `getFoo` methods are based on the last statusUpdate.
*
* @param follow: Do we have to follow following downloads.
*/
void updateStatus(bool follow=false);
void updateStatus(bool follow);
/**
* Pause the download (and call updateStatus)