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

fixed the definition of torrent_handle::is_paused() to be consistent with torrent_status::paused and made it clear in the documentation

This commit is contained in:
Arvid Norberg 2008-08-21 11:24:24 +00:00
parent e58485822b
commit 635341f1e4
3 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manual.html
View File

@ -1922,6 +1922,10 @@ When a torrent is paused, it will however remember all share ratios to all peers
all potential (not connected) peers. You can use <tt class="docutils literal"><span class="pre">is_paused()</span></tt> to determine if a torrent
is currently paused. Torrents may be paused automatically if there is a file error (e.g. disk full)
or something similar. See <a class="reference" href="#file-error-alert">file_error_alert</a>.</p>
<p><tt class="docutils literal"><span class="pre">is_paused()</span></tt> only returns true if the torrent itself is paused. If the torrent
is not running because the session is paused, this still returns true. To know if a
torrent is active or not, you need to inspect both <tt class="docutils literal"><span class="pre">torrent_handle::is_paused()</span></tt>
and <tt class="docutils literal"><span class="pre">session::is_paused()</span></tt>.</p>
</div>
<div class="section">
<h2><a id="force-recheck" name="force-recheck">force_recheck()</a></h2>

5
docs/manual.rst
View File

@ -1852,6 +1852,11 @@ all potential (not connected) peers. You can use ``is_paused()`` to determine if
is currently paused. Torrents may be paused automatically if there is a file error (e.g. disk full)
or something similar. See file_error_alert_.
``is_paused()`` only returns true if the torrent itself is paused. If the torrent
is not running because the session is paused, this still returns true. To know if a
torrent is active or not, you need to inspect both ``torrent_handle::is_paused()``
and ``session::is_paused()``.
force_recheck()
---------------

2
src/torrent_handle.cpp
View File

@ -250,7 +250,7 @@ namespace libtorrent
bool torrent_handle::is_paused() const
{
INVARIANT_CHECK;
TORRENT_FORWARD_RETURN(is_paused(), false);
TORRENT_FORWARD_RETURN(is_torrent_paused(), false);
}
void torrent_handle::pause() const