diff --git a/docs/manual.html b/docs/manual.html index 643879dec..7f786facd 100644 --- a/docs/manual.html +++ b/docs/manual.html @@ -74,216 +74,220 @@
In the python binding, wait_for_alert takes the number of milliseconds to wait as an integer.
set_alert_queue_size_limit() you can specify how many alerts can be awaiting for dispatching. If this limit is reached, new incoming alerts can not be received until alerts are popped by calling pop_alert. Default value is 1000.
+save_resume_data_alert and save_resume_data_failed_alert are always posted, regardelss +of the alert mask.
These functions returns references to their respective current settings.
The dht_proxy is not available when DHT is disabled.
+++void set_i2p_proxy(proxy_settings const&); +proxy_settings const& i2p_proxy(); ++
set_i2p_proxy sets the i2p proxy, and tries to open a persistant +connection to it. The only used fields in the proxy settings structs +are hostname and port.
+i2p_proxy returns the current i2p proxy in use.
+@@ -1984,6 +2004,8 @@ struct torrent_handle void queue_position_top() const; void queue_position_bottom() const; + void set_priority(int prio) const; + void use_interface(char const* net_interface) const; void pause() const; @@ -2069,6 +2091,8 @@ piece has been downloaded, by passing alert_when_available flag is set, in which case it will do the same thing as calling read_piece() for index. +In the python binding for this function, the deadline is the number of milliseconds +as an integer.
+++void set_priority(int prio) const; ++
This sets the bandwidth priority of this torrent. The priority of a torrent determines +how much bandwidth its peers are assigned when distributing upload and download rate quotas. +A high number gives more bandwidth. The priority must be within the range [0, 255].
+The default priority is 0, which is the lowest priority.
+To query the priority of a torrent, use the `status()`_ call.
+Torrents with higher priority will not nececcarily get as much bandwidth as they can +consume, even if there's is more quota. Other peers will still be weighed in when +bandwidth is being distributed. With other words, bandwidth is not distributed strictly +in order of priority, but the priority is used as a weight.
+@@ -2889,6 +2930,7 @@ struct torrent_status size_type all_time_download; int active_time; + int finished_time; int seeding_time; int seed_rank; @@ -2902,6 +2944,8 @@ struct torrent_status bool seed_mode; bool upload_mode; + + int priority; };progress is a value in the range [0, 1], that represents the progress of the @@ -3068,11 +3112,12 @@ the session_status ob
all_time_upload and all_time_download are accumulated upload and download payload byte counters. They are saved in and restored from resume data to keep totals across sessions.
-active_time and seeding_time are second counters. They keep track of the -number of seconds this torrent has been active (not paused) and the number of -seconds it has been active while being a seed. seeding_time should be >= -active_time They are saved in and restored from resume data, to keep totals -across sessions.
+active_time, finished_time and seeding_time are second counters. +They keep track of the number of seconds this torrent has been active (not +paused) and the number of seconds it has been active while being finished and +active while being a seed. seeding_time should be >= finished_time which +should be >= active_time. They are all saved in and restored from resume data, +to keep totals across sessions.
seed_rank is a rank of how important it is to seed the torrent, it is used to determine which torrents to seed and which to queue. It is based on the peer to seed ratio from the tracker scrape. For more information, see queuing.
@@ -3564,6 +3609,8 @@ struct session_settings int optimistic_disk_retry; bool disable_hash_check; + + int max_suggest_pieces; };user_agent this is the client identification to the tracker. @@ -3687,10 +3734,11 @@ thread catches up. Setting this too low will severly limit your download rate.
handshake_timeout specifies the number of seconds we allow a peer to delay responding to a protocol handshake. If no response is received within this time, the connection is closed.
-use_dht_as_fallback determines how the DHT is used. If this is true -(which it is by default), the DHT will only be used for torrents where -all trackers in its tracker list has failed. Either by an explicit error -message or a time out.
+use_dht_as_fallback determines how the DHT is used. If this is true, +the DHT will only be used for torrents where all trackers in its tracker +list has failed. Either by an explicit error message or a time out. This +is false by default, which means the DHT is used by default regardless of +if the trackers fail or not.
free_torrent_hashes determines whether or not the torrent's piece hashes are kept in memory after the torrent becomes a seed or not. If it is set to true the hashes are freed once the torrent is a seed (they're not @@ -3904,6 +3952,9 @@ the piece hashes in the torrent file or not. The default is false, i.e. to verify all downloaded data. It may be useful to turn this off for performance profiling and simulation scenarios. Do not disable the hash check for regular bittorrent clients.
+max_suggest_pieces is the max number of suggested piece indices received +from a peer that's remembered. If a peer floods suggest messages, this limit +prevents libtorrent from using too much RAM. It defaults to 10.
This alert is generated when none of the ports, given in the port range, to -session can be opened for listening. This alert doesn't have any extra -data members.
+session can be opened for listening. The endpoint member is the +interface and port that failed, error is the error code describing +the failure. ++struct listen_failed_alert: alert +{ + // ... + tcp::endpoint endpoint; + error_code error; +}; ++
This alert is posted when the listen port succeeds to be opened on a +particular interface. endpoint is the endpoint that successfully +was opened for listening.
++struct listen_succeeded_alert: alert +{ + // ... + tcp::endpoint endpoint; +}; +
This alert is posted every time an outgoing peer connect attempts succeeds.
++struct peer_connect_alert: peer_alert +{ + // ... +}; ++
This alert is generated when a peer is banned because it has sent too many corrupt pieces @@ -5059,7 +5142,8 @@ struct performance_alert: torrent_alert outstanding_disk_buffer_limit_reached, outstanding_request_limit_reached, upload_limit_too_low, - download_limit_too_low + download_limit_too_low, + send_buffer_watermark_too_low }; performance_warning_t warning_code; @@ -5113,7 +5197,7 @@ struct fastresume_rejected_alert: torrent_alert
This alert is generated when a peer is blocked by the IP filter. The ip member is the address that was blocked.
-struct peer_blocked_alert: alert +struct peer_blocked_alert: torrent_alert { // ... address ip; @@ -5217,17 +5301,17 @@ struct dht_get_peers_alert: alertstruct my_handler { - void operator()(portmap_error_alert const& a) + void operator()(portmap_error_alert const& a) const { std::cout << "Portmapper: " << a.msg << std::endl; } - void operator()(tracker_warning_alert const& a) + void operator()(tracker_warning_alert const& a) const { std::cout << "Tracker warning: " << a.msg << std::endl; } - void operator()(torrent_finished_alert const& a) + void operator()(torrent_finished_alert const& a) const { // write fast resume data // ... @@ -6105,7 +6189,7 @@ bool move_storage(fs::path save_path) = 0; The default storage moves the single file or the directory of the torrent.Before moving the files, any open file handles may have to be closed, like release_files().
-Returning true indicates an error occurred.
+Returning false indicates an error occurred.
for example. For more information, see the Boost.Filesystem docs.
+