smallsolar
/
libkiwix
mirror of https://github.com/kiwix/libkiwix.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documented the problem with startDownload()

This commit is contained in:
Veloman Yunkan 2024-02-27 19:19:45 +04:00
parent 922c138809
commit ff88430227
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/downloader.h
View File

@ -177,7 +177,16 @@ class Downloader
/**
* Start a new download.
*
* This method is thread safe and return a pointer to a newly created `Download`.
* This method is thread safe and returns a pointer to a newly created
* `Download` or an existing one with a matching URI. In the latter case
* the options parameter is ignored, which can lead to surprising results.
* For example, if the old and new download requests (sharing the same URI)
* have different values for the download directory or output file name
* options, after the download is reported to be complete the downloaded file
* will be present only at the location specified for the first request.
* Also, due to the above peculiarity there is no straightforward way to
* repeat a completed or cancelled download whose files have been deleted.
*
* User should call `update` on the returned `Download` to have an accurate status.
*
* @param uri: The uri of the thing to download.