wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

improve documentation for a few torrent flags

This commit is contained in:
arvidn 2020-03-20 13:13:46 +01:00 committed by Arvid Norberg
parent be10ccd881
commit 781c17363d
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
include/libtorrent/torrent_flags.hpp
View File

@ -136,28 +136,29 @@ namespace torrent_flags {
// updates when calling post_torrent_updates(). // updates when calling post_torrent_updates().
constexpr torrent_flags_t update_subscribe = 7_bit; constexpr torrent_flags_t update_subscribe = 7_bit;
// sets the torrent into super seeding mode. If the torrent is not a // sets the torrent into super seeding/initial seeding mode. If the torrent
// seed, this flag has no effect. It has the same effect as calling // is not a seed, this flag has no effect.
// ``torrent_handle::super_seeding(true)`` on the torrent handle
// immediately after adding it.
constexpr torrent_flags_t super_seeding = 8_bit; constexpr torrent_flags_t super_seeding = 8_bit;
// sets the sequential download state for the torrent. It has the same // sets the sequential download state for the torrent. In this mode the
// effect as calling ``torrent_handle::sequential_download(true)`` on // piece picker will pick pieces with low index numbers before pieces with
// the torrent handle immediately after adding it. // high indices. The actual pieces that are picked depend on other factors
// still, such as which pieces a peer has and whether it is in parole mode
// or "prefer whole pieces"-mode. Sequential mode is not ideal for streaming
// media. For that, see set_piece_deadline() instead.
constexpr torrent_flags_t sequential_download = 9_bit; constexpr torrent_flags_t sequential_download = 9_bit;
// When this flag is set, the // When this flag is set, the torrent will *force stop* whenever it
// torrent will *force stop* whenever it transitions from a // transitions from a non-data-transferring state into a data-transferring
// non-data-transferring state into a data-transferring state (referred to // state (referred to as being ready to download or seed). This is useful
// as being ready to download or seed). This is useful for torrents that // for torrents that should not start downloading or seeding yet, but want
// should not start downloading or seeding yet, but want to be made ready // to be made ready to do so. A torrent may need to have its files checked
// to do so. A torrent may need to have its files checked for instance, so // for instance, so it needs to be started and possibly queued for checking
// it needs to be started and possibly queued for checking (auto-managed // (auto-managed and started) but as soon as it's done, it should be
// and started) but as soon as it's done, it should be stopped. // stopped.
// //
// *Force stopped* means auto-managed is set to false and it's paused. As // *Force stopped* means auto-managed is set to false and it's paused. As
// if auto_manage(false) and pause() were called on the torrent. // if the auto_manages flag is cleared and the paused flag is set on the torrent.
// //
// Note that the torrent may transition into a downloading state while // Note that the torrent may transition into a downloading state while
// calling this function, and since the logic is edge triggered you may // calling this function, and since the logic is edge triggered you may