premiere
/
premiere-libtorrent
2
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity

update documentation for save_resume_data() and stop_when_ready()

This commit is contained in:
Arvid Norberg 2018-08-07 19:36:25 +02:00 committed by Arvid Norberg
parent 149c24e549
commit 0a5b3c1bb0
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/libtorrent/torrent_handle.hpp
View File

@ -603,6 +603,11 @@ namespace libtorrent
// for the state_changed_alert and then call pause(). The download/seeding // for the state_changed_alert and then call pause(). The download/seeding
// will most likely start in between posting the alert and receiving the // will most likely start in between posting the alert and receiving the
// call to pause. // call to pause.
//
// A downloading state is one where peers are being connected. Which means
// just downloading the metadata via the ``ut_metadata`` extension counts
// as a downloading state. In order to stop a torrent once the metadata
// has been downloaded, instead set all file priorities to dont_download
void stop_when_ready(bool b) const; void stop_when_ready(bool b) const;
// Explicitly sets the upload mode of the torrent. In upload mode, the // Explicitly sets the upload mode of the torrent. In upload mode, the
@ -741,9 +746,8 @@ namespace libtorrent
// extern int outstanding_resume_data; // global counter of outstanding resume data // extern int outstanding_resume_data; // global counter of outstanding resume data
// std::vector<torrent_handle> handles = ses.get_torrents(); // std::vector<torrent_handle> handles = ses.get_torrents();
// ses.pause(); // ses.pause();
// for (torrent_handle i : handles) // for (torrent_handle const& h : handles)
// { // {
// torrent_handle& h = *i;
// if (!h.is_valid()) continue; // if (!h.is_valid()) continue;
// torrent_status s = h.status(); // torrent_status s = h.status();
// if (!s.has_metadata) continue; // if (!s.has_metadata) continue;
@ -758,7 +762,7 @@ namespace libtorrent
// alert const* a = ses.wait_for_alert(seconds(10)); // alert const* a = ses.wait_for_alert(seconds(10));
// //
// // if we don't get an alert within 10 seconds, abort // // if we don't get an alert within 10 seconds, abort
// if (a == 0) break; // if (a == nullptr) break;
// //
// std::vector<alert*> alerts; // std::vector<alert*> alerts;
// ses.pop_alerts(&alerts); // ses.pop_alerts(&alerts);
@ -773,7 +777,7 @@ namespace libtorrent
// } // }
// //
// save_resume_data_alert const* rd = alert_cast<save_resume_data_alert>(a); // save_resume_data_alert const* rd = alert_cast<save_resume_data_alert>(a);
// if (rd == 0) // if (rd == nullptr)
// { // {
// process_alert(a); // process_alert(a);
// continue; // continue;
@ -807,9 +811,10 @@ namespace libtorrent
// time. // time.
// //
//.. note:: //.. note::
// A torrent's resume data is considered saved as soon as the alert is // A torrent's resume data is considered saved as soon as the
// posted. It is important to make sure this alert is received and // save_resume_data_alert is posted. It is important to make sure this
// handled in order for this function to be meaningful. // alert is received and handled in order for this function to be
// meaningful.
bool need_save_resume_data() const; bool need_save_resume_data() const;
// changes whether the torrent is auto managed or not. For more info, // changes whether the torrent is auto managed or not. For more info,

4
src/torrent.cpp
View File

@ -117,7 +117,7 @@ namespace libtorrent
boost::uint32_t const unset = std::numeric_limits<boost::uint32_t>::max(); boost::uint32_t const unset = std::numeric_limits<boost::uint32_t>::max();
bool is_downloading_state(int st) bool is_downloading_state(int const st)
{ {
switch (st) switch (st)
{ {
@ -8498,7 +8498,7 @@ namespace {
namespace { namespace {
#ifndef TORRENT_DISABLE_LOGGING #ifndef TORRENT_DISABLE_LOGGING
char const* list_name(int idx) char const* list_name(int const idx)
{ {
#define TORRENT_LIST_NAME(n) case aux::session_interface:: n: return #n; #define TORRENT_LIST_NAME(n) case aux::session_interface:: n: return #n;
switch (idx) switch (idx)