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

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()
---------------