update documentation to mention read_resume_data()
This commit is contained in:
parent
516db1fc97
commit
28ca7f8303
|
@ -356,11 +356,12 @@ fast-resume data. The fast-resume data also contains information about which
|
||||||
blocks, in the unfinished pieces, were downloaded, so it will not have to
|
blocks, in the unfinished pieces, were downloaded, so it will not have to
|
||||||
start from scratch on the partially downloaded pieces.
|
start from scratch on the partially downloaded pieces.
|
||||||
|
|
||||||
To use the fast-resume data you simply give it to async_add_torrent() and
|
To use the fast-resume data you pass it to read_resume_data(), which will return
|
||||||
add_torrent(), and it will skip the time consuming checks. It may have to do
|
an add_torrent_params object. Fields of this object can then be altered before
|
||||||
|
passing it to async_add_torrent() or add_torrent().
|
||||||
|
The session will then skip the time consuming checks. It may have to do
|
||||||
the checking anyway, if the fast-resume data is corrupt or doesn't fit the
|
the checking anyway, if the fast-resume data is corrupt or doesn't fit the
|
||||||
storage for that torrent, then it will not trust the fast-resume data and just
|
storage for that torrent.
|
||||||
do the checking.
|
|
||||||
|
|
||||||
file format
|
file format
|
||||||
-----------
|
-----------
|
||||||
|
|
Loading…
Reference in New Issue