diff --git a/docs/manual.rst b/docs/manual.rst
index df78e54f6..218d25f3c 100755
--- a/docs/manual.rst
+++ b/docs/manual.rst
@@ -18,51 +18,51 @@ example client.
The main goals of libtorrent are:
- * to be cpu efficient
- * to be memory efficient
- * to be very easy to use
+* to be cpu efficient
+* to be memory efficient
+* to be very easy to use
libtorrent is still being developed, however it is stable. It is an ongoing
project (including this documentation). The current state includes the
following features:
- * multitracker extension support (as `specified by John Hoffman`__)
- * serves multiple torrents on a single port and a single thread
- * supports http proxies and proxy authentication
- * gzipped tracker-responses
- * `HTTP seeding`_, as `specified by Michael Burford of GetRight`__.
- * piece picking on block-level like in Azureus_ (as opposed to piece-level).
- This means it can download parts of the same piece from different peers.
- It will also prefer to download whole pieces from single peers if the
- download speed is high enough from that particular peer.
- * queues torrents for file check, instead of checking all of them in parallel.
- * uses separate threads for checking files and for main downloader, with a
- fool-proof thread-safe library interface. (i.e. There's no way for the
- user to cause a deadlock). (see threads_)
- * can limit the upload and download bandwidth usage and the maximum number of
- unchoked peers
- * piece-wise, unordered, incremental file allocation
- * implements fair trade. User settable trade-ratio, must at least be 1:1,
- but one can choose to trade 1 for 2 or any other ratio that isn't unfair
- to the other party.
- * fast resume support, a way to get rid of the costly piece check at the
- start of a resumed torrent. Saves the storage state, piece_picker state
- as well as all local peers in a separate fast-resume file.
- * supports an `extension protocol`__. See extensions_.
- * supports files > 2 gigabytes.
- * supports the ``no_peer_id=1`` extension that will ease the load off trackers.
- * supports the `udp-tracker protocol`__ by Olaf van der Spek.
- * possibility to limit the number of connections.
- * delays have messages if there's no other outgoing traffic to the peer, and
- doesn't send have messages to peers that already has the piece. This saves
- bandwidth.
- * does not have any requirements on the piece order in a torrent that it
- resumes. This means it can resume a torrent downloaded by any client.
- * adjusts the length of the request queue depending on download rate.
- * supports the ``compact=1`` tracker parameter.
- * selective downloading. The ability to select which parts of a torrent you
- want to download.
- * ip filter
+* multitracker extension support (as `specified by John Hoffman`__)
+* serves multiple torrents on a single port and a single thread
+* supports http proxies and proxy authentication
+* gzipped tracker-responses
+* `HTTP seeding`_, as `specified by Michael Burford of GetRight`__.
+* piece picking on block-level like in Azureus_ (as opposed to piece-level).
+ This means it can download parts of the same piece from different peers.
+ It will also prefer to download whole pieces from single peers if the
+ download speed is high enough from that particular peer.
+* queues torrents for file check, instead of checking all of them in parallel.
+* uses separate threads for checking files and for main downloader, with a
+ fool-proof thread-safe library interface. (i.e. There's no way for the
+ user to cause a deadlock). (see threads_)
+* can limit the upload and download bandwidth usage and the maximum number of
+ unchoked peers
+* piece-wise, unordered, incremental file allocation
+* implements fair trade. User settable trade-ratio, must at least be 1:1,
+ but one can choose to trade 1 for 2 or any other ratio that isn't unfair
+ to the other party.
+* fast resume support, a way to get rid of the costly piece check at the
+ start of a resumed torrent. Saves the storage state, piece_picker state
+ as well as all local peers in a separate fast-resume file.
+* supports an `extension protocol`__. See extensions_.
+* supports files > 2 gigabytes.
+* supports the ``no_peer_id=1`` extension that will ease the load off trackers.
+* supports the `udp-tracker protocol`__ by Olaf van der Spek.
+* possibility to limit the number of connections.
+* delays have messages if there's no other outgoing traffic to the peer, and
+ doesn't send have messages to peers that already has the piece. This saves
+ bandwidth.
+* does not have any requirements on the piece order in a torrent that it
+ resumes. This means it can resume a torrent downloaded by any client.
+* adjusts the length of the request queue depending on download rate.
+* supports the ``compact=1`` tracker parameter.
+* selective downloading. The ability to select which parts of a torrent you
+ want to download.
+* ip filter
__ http://home.elp.rr.com/tur/multitracker-spec.txt
__ http://www.getright.com/seedtorrent.html
@@ -84,16 +84,16 @@ epoll on linux and kqueue on MacOS X and BSD.
libtorrent has been successfully compiled and tested on:
- * Windows 2000 vc7.1
- * Linux x86 GCC 3.3, GCC 3.4.2
- * MacOS X (darwin), (Apple's) GCC 3.3, (Apple's) GCC 4.0
- * SunOS 5.8 GCC 3.1
- * Cygwin GCC 3.3.3
+* Windows 2000 vc7.1
+* Linux x86 GCC 3.3, GCC 3.4.2
+* MacOS X (darwin), (Apple's) GCC 3.3, (Apple's) GCC 4.0
+* SunOS 5.8 GCC 3.1
+* Cygwin GCC 3.3.3
Fails on:
- * GCC 2.95.4
- * msvc6
+* GCC 2.95.4
+* msvc6
libtorrent is released under the BSD-license_.
@@ -263,12 +263,12 @@ For more build configuration flags see `Build configurations`_.
The ``Jamfile`` has the following build variants:
- * ``release`` - release version without any logging
- * ``release_log`` - release version with standard logging
- * ``release_vlog`` - release version with verbose logging (all peer connections are logged)
- * ``debug`` - debug version without any logging
- * ``debug_log`` - debug version with standard logging
- * ``debug_vlog`` - debug version with verbose logging
+* ``release`` - release version without any logging
+* ``release_log`` - release version with standard logging
+* ``release_vlog`` - release version with verbose logging (all peer connections are logged)
+* ``debug`` - debug version without any logging
+* ``debug_log`` - debug version with standard logging
+* ``debug_vlog`` - debug version with verbose logging
When building the example client on windows, you need to build with
``link=static`` otherwise you may get unresolved external symbols for some
@@ -1039,7 +1039,6 @@ The ``torrent_info`` has the following synopsis::
boost::optional
creation_date() const;
-
void print(std::ostream& os) const;
size_type piece_size(unsigned int index) const;
@@ -1335,8 +1334,6 @@ it will return an empty string.
__ http://www.boost.org/libs/date_time/doc/class_ptime.html
-
-
torrent_handle
==============
@@ -1349,6 +1346,7 @@ Its declaration looks like this::
torrent_handle();
torrent_status status();
+ void file_progress(std::vector& fp);
void get_download_queue(std::vector& queue) const;
void get_peer_info(std::vector& v) const;
torrent_info const& get_torrent_info() const;
@@ -1408,6 +1406,19 @@ any operation on an uninitialized handle, it will throw ``invalid_handle``.
*TODO: document filter_piece(), filter_pieces(), is_piece_filtered(), filtered_pieces() and filter_files()*
+file_progress()
+---------------
+
+ ::
+
+ void file_progress(std::vector& fp);
+
+This function fills in the supplied vector with the progress (a value in the
+range [0, 1]) describing the download progress of each file in this torrent.
+The progress values are ordered the same as the files in the `torrent_info`_.
+This operation is not very cheap.
+
+
save_path()
-----------
diff --git a/examples/client_test.cpp b/examples/client_test.cpp
index a16a1e73c..a7d678452 100755
--- a/examples/client_test.cpp
+++ b/examples/client_test.cpp
@@ -625,6 +625,7 @@ int main(int ac, char* av[])
bool print_peers = false;
bool print_log = false;
bool print_downloads = false;
+ bool print_file_progress = false;
for (;;)
{
@@ -679,6 +680,7 @@ int main(int ac, char* av[])
if (c == 'i') print_peers = !print_peers;
if (c == 'l') print_log = !print_log;
if (c == 'd') print_downloads = !print_downloads;
+ if (c == 'f') print_file_progress = !print_file_progress;
}
// loop through the alert queue to see if anything has happened.
@@ -827,6 +829,27 @@ int main(int ac, char* av[])
out << "___________________________________\n";
}
+
+ if (print_file_progress
+ && s.state != torrent_status::seeding
+ && h.has_metadata())
+ {
+ std::vector file_progress;
+ h.file_progress(file_progress);
+ torrent_info const& info = h.get_torrent_info();
+ for (int i = 0; i < info.num_files(); ++i)
+ {
+ if (file_progress[i] == 1.f)
+ out << progress_bar(file_progress[i], 10, "32") << " "
+ << info.file_at(i).path.leaf() << "\n";
+ else
+ out << progress_bar(file_progress[i], 10, "33") << " "
+ << info.file_at(i).path.leaf() << "\n";
+ }
+
+ out << "___________________________________\n";
+ }
+
}
if (print_log)
diff --git a/include/libtorrent/torrent.hpp b/include/libtorrent/torrent.hpp
index f0fe154b1..a96a440cc 100755
--- a/include/libtorrent/torrent.hpp
+++ b/include/libtorrent/torrent.hpp
@@ -169,6 +169,7 @@ namespace libtorrent
void filter_files(std::vector const& files);
torrent_status status() const;
+ void file_progress(std::vector& fp) const;
void use_interface(const char* net_interface);
tcp::endpoint const& get_interface() const { return m_net_interface; }
diff --git a/include/libtorrent/torrent_handle.hpp b/include/libtorrent/torrent_handle.hpp
index b01a862e2..54b5d8a4e 100755
--- a/include/libtorrent/torrent_handle.hpp
+++ b/include/libtorrent/torrent_handle.hpp
@@ -224,6 +224,11 @@ namespace libtorrent
bool send_chat_message(tcp::endpoint ip, std::string message) const;
torrent_status status() const;
void get_download_queue(std::vector& queue) const;
+
+ // fills the specified vector with the download progress [0, 1]
+ // of each file in the torrent. The files are ordered as in
+ // the torrent_info.
+ void file_progress(std::vector& progress);
std::vector const& trackers() const;
void replace_trackers(std::vector const&) const;
@@ -291,9 +296,6 @@ namespace libtorrent
// the ratio is uploaded / downloaded. less than 1 is not allowed
void set_ratio(float up_down_ratio) const;
- // TODO: add finish_file_allocation, which will force the
- // torrent to allocate storage for all pieces.
-
boost::filesystem::path save_path() const;
// -1 means unlimited unchokes