From 58b3061f11a0e9575e747c4990c517786b2b1755 Mon Sep 17 00:00:00 2001 From: Arvid Norberg Date: Sun, 30 Nov 2008 07:59:29 +0000 Subject: [PATCH] regenerated html --- docs/manual.html | 422 ++++++++++++++++++++++++++--------------------- 1 file changed, 238 insertions(+), 184 deletions(-) diff --git a/docs/manual.html b/docs/manual.html index c666d2ab2..c6dc41de0 100644 --- a/docs/manual.html +++ b/docs/manual.html @@ -44,214 +44,215 @@

Table of contents

@@ -1595,9 +1596,37 @@ struct announce_entry { announce_entry(std::string const& url); std::string url; - int tier; + boost::uint8_t tier; + boost::uint8_t fail_limit; + boost::uint8_t fails; + + enum tracker_source + { + source_torrent = 1, + source_client = 2, + source_magnet_link = 4, + source_tex = 8 + }; + boost::uint8_t source; + + bool verified:1; + bool updating:1; + bool start_sent:1; + bool complete_sent:1; }; +

fail_limit is the max number of failures to announce to this tracker in +a row, before this tracker is not used anymore.

+

fails is the number of times in a row we have failed to announce to this +tracker.

+

source is a bitmask specifying which sources we got this tracker from.

+

verified is set to true the first time we receive a valid response +from this tracker.

+

updating is true while we're waiting for a response from the tracker.

+

start_sent is set to true when we get a valid response from an announce +with event=started. If it is set, we won't send start in the subsequent +announces.

+

complete_sent is set to true when we send a event=completed.

total_size() piece_length() piece_size() num_pieces()

@@ -1722,6 +1751,7 @@ struct torrent_handle std::vector<announce_entry> const& trackers() const; void replace_trackers(std::vector<announce_entry> const&); + void add_tracker(announc_entry const& url); void add_url_seed(std::string const& url); void remove_url_seed(std::string const& url); @@ -1777,6 +1807,7 @@ struct torrent_handle boost::filesystem::path save_path() const; void move_storage(boost::filesystem::path const& save_path) const; + void rename_file(int index, boost::filesystem::path) const; storage_interface* get_storage_impl() const; sha1_hash info_hash() const; @@ -1899,6 +1930,16 @@ drop while copying the file.

Once the operation completes, the storage_moved_alert is generated, with the new path as the message.

+
+

rename_file()

+
+
+void rename_file(int index, boost::filesystem::path) const;
+
+
+

Renames the file with the given index asynchronously. The rename operation is complete +when either a file_renamed_alert or file_rename_failed_alert is posted.

+

get_storage_impl()

@@ -2127,12 +2168,13 @@ void set_tracker_login(std::string const& username

set_tracker_login() sets a username and password that will be sent along in the HTTP-request of the tracker announce. Set this if the tracker requires authorization.

-
-

trackers() replace_trackers()

+
+

trackers() replace_trackers() add_tracker()

 std::vector<announce_entry> const& trackers() const;
 void replace_trackers(std::vector<announce_entry> const&) const;
+void add_tracker(announc_entry const& url);

trackers() will return the list of trackers for this torrent. The @@ -2143,6 +2185,9 @@ trackers for this torrent, you can use trackers() and will replace it. If you want an immediate effect, you have to call force_reannounce().

+

add_tracker() will look if the specified tracker is already in the set. +If it is, it doesn't do anything. If it's not in the current set of trackers, +it will insert it in the tier specified in the announce_entry.

add_url_seed() remove_url_seed() url_seeds()

@@ -3078,6 +3123,8 @@ struct session_settings int auto_manage_startup; bool rate_limit_ip_overhead; + + bool announce_to_all_trackers; };

user_agent this is the client identification to the tracker. @@ -3303,6 +3350,13 @@ is so that newly started torrents are not considered inactive until they have a fair chance to start downloading.

If rate_limit_ip_overhead is set to true, the estimated TCP/IP overhead is drained from the rate limiters, to avoid exceeding the limits with the total traffic

+

announce_to_all_trackers controls how multi tracker torrents are +treated. If this is set to true, all trackers in the same tier are +announced to in parallel. If all trackers in tier 0 fails, all trackers +in tier 1 are announced as well. This is the uTorrent behavior. If it's +set to false, the behavior is as defined by the multi tracker +specification. It defaults to false, which is the same behavior previous +versions of libtorrent has had as well.

pe_settings

@@ -4658,7 +4712,7 @@ struct partial_hash that is stored in the given slot.

The function should return the hash of the piece stored in the slot.

-
+

rename_file()