regenerated html
This commit is contained in:
480
docs/manual.html
480
docs/manual.html
@@ -74,216 +74,220 @@
|
||||
<li><a class="reference internal" href="#set-settings-set-pe-settings" id="id43">set_settings() set_pe_settings()</a></li>
|
||||
<li><a class="reference internal" href="#set-peer-proxy-set-web-seed-proxy-set-tracker-proxy-set-dht-proxy" id="id44">set_peer_proxy() set_web_seed_proxy() set_tracker_proxy() set_dht_proxy()</a></li>
|
||||
<li><a class="reference internal" href="#peer-proxy-web-seed-proxy-tracker-proxy-dht-proxy" id="id45">peer_proxy() web_seed_proxy() tracker_proxy() dht_proxy()</a></li>
|
||||
<li><a class="reference internal" href="#start-dht-stop-dht-set-dht-settings-dht-state" id="id46">start_dht() stop_dht() set_dht_settings() dht_state()</a></li>
|
||||
<li><a class="reference internal" href="#add-dht-node-add-dht-router" id="id47">add_dht_node() add_dht_router()</a></li>
|
||||
<li><a class="reference internal" href="#start-lsd-stop-lsd" id="id48">start_lsd() stop_lsd()</a></li>
|
||||
<li><a class="reference internal" href="#start-upnp-stop-upnp" id="id49">start_upnp() stop_upnp()</a></li>
|
||||
<li><a class="reference internal" href="#start-natpmp-stop-natpmp" id="id50">start_natpmp() stop_natpmp()</a></li>
|
||||
<li><a class="reference internal" href="#set-i2p-proxy-i2p-proxy" id="id46">set_i2p_proxy() i2p_proxy()</a></li>
|
||||
<li><a class="reference internal" href="#start-dht-stop-dht-set-dht-settings-dht-state" id="id47">start_dht() stop_dht() set_dht_settings() dht_state()</a></li>
|
||||
<li><a class="reference internal" href="#add-dht-node-add-dht-router" id="id48">add_dht_node() add_dht_router()</a></li>
|
||||
<li><a class="reference internal" href="#start-lsd-stop-lsd" id="id49">start_lsd() stop_lsd()</a></li>
|
||||
<li><a class="reference internal" href="#start-upnp-stop-upnp" id="id50">start_upnp() stop_upnp()</a></li>
|
||||
<li><a class="reference internal" href="#start-natpmp-stop-natpmp" id="id51">start_natpmp() stop_natpmp()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#entry" id="id51">entry</a><ul>
|
||||
<li><a class="reference internal" href="#integer-string-list-dict-type" id="id52">integer() string() list() dict() type()</a></li>
|
||||
<li><a class="reference internal" href="#operator" id="id53">operator[]</a></li>
|
||||
<li><a class="reference internal" href="#find-key" id="id54">find_key()</a></li>
|
||||
<li><a class="reference internal" href="#entry" id="id52">entry</a><ul>
|
||||
<li><a class="reference internal" href="#integer-string-list-dict-type" id="id53">integer() string() list() dict() type()</a></li>
|
||||
<li><a class="reference internal" href="#operator" id="id54">operator[]</a></li>
|
||||
<li><a class="reference internal" href="#find-key" id="id55">find_key()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#torrent-info" id="id55">torrent_info</a><ul>
|
||||
<li><a class="reference internal" href="#id3" id="id56">torrent_info()</a></li>
|
||||
<li><a class="reference internal" href="#add-tracker" id="id57">add_tracker()</a></li>
|
||||
<li><a class="reference internal" href="#files-orig-files" id="id58">files() orig_files()</a></li>
|
||||
<li><a class="reference internal" href="#rename-file" id="id59">rename_file()</a></li>
|
||||
<li><a class="reference internal" href="#begin-files-end-files-rbegin-files-rend-files" id="id60">begin_files() end_files() rbegin_files() rend_files()</a></li>
|
||||
<li><a class="reference internal" href="#num-files-file-at" id="id61">num_files() file_at()</a></li>
|
||||
<li><a class="reference internal" href="#map-block" id="id62">map_block()</a></li>
|
||||
<li><a class="reference internal" href="#map-file" id="id63">map_file()</a></li>
|
||||
<li><a class="reference internal" href="#url-seeds-add-url-seed-http-seeds-add-http-seed" id="id64">url_seeds() add_url_seed() http_seeds() add_http_seed()</a></li>
|
||||
<li><a class="reference internal" href="#trackers" id="id65">trackers()</a></li>
|
||||
<li><a class="reference internal" href="#total-size-piece-length-piece-size-num-pieces" id="id66">total_size() piece_length() piece_size() num_pieces()</a></li>
|
||||
<li><a class="reference internal" href="#hash-for-piece-hash-for-piece-ptr-info-hash" id="id67">hash_for_piece() hash_for_piece_ptr() info_hash()</a></li>
|
||||
<li><a class="reference internal" href="#name-comment-creation-date-creator" id="id68">name() comment() creation_date() creator()</a></li>
|
||||
<li><a class="reference internal" href="#priv" id="id69">priv()</a></li>
|
||||
<li><a class="reference internal" href="#nodes" id="id70">nodes()</a></li>
|
||||
<li><a class="reference internal" href="#add-node" id="id71">add_node()</a></li>
|
||||
<li><a class="reference internal" href="#metadata-metadata-size" id="id72">metadata() metadata_size()</a></li>
|
||||
<li><a class="reference internal" href="#torrent-info" id="id56">torrent_info</a><ul>
|
||||
<li><a class="reference internal" href="#id3" id="id57">torrent_info()</a></li>
|
||||
<li><a class="reference internal" href="#add-tracker" id="id58">add_tracker()</a></li>
|
||||
<li><a class="reference internal" href="#files-orig-files" id="id59">files() orig_files()</a></li>
|
||||
<li><a class="reference internal" href="#rename-file" id="id60">rename_file()</a></li>
|
||||
<li><a class="reference internal" href="#begin-files-end-files-rbegin-files-rend-files" id="id61">begin_files() end_files() rbegin_files() rend_files()</a></li>
|
||||
<li><a class="reference internal" href="#num-files-file-at" id="id62">num_files() file_at()</a></li>
|
||||
<li><a class="reference internal" href="#map-block" id="id63">map_block()</a></li>
|
||||
<li><a class="reference internal" href="#map-file" id="id64">map_file()</a></li>
|
||||
<li><a class="reference internal" href="#url-seeds-add-url-seed-http-seeds-add-http-seed" id="id65">url_seeds() add_url_seed() http_seeds() add_http_seed()</a></li>
|
||||
<li><a class="reference internal" href="#trackers" id="id66">trackers()</a></li>
|
||||
<li><a class="reference internal" href="#total-size-piece-length-piece-size-num-pieces" id="id67">total_size() piece_length() piece_size() num_pieces()</a></li>
|
||||
<li><a class="reference internal" href="#hash-for-piece-hash-for-piece-ptr-info-hash" id="id68">hash_for_piece() hash_for_piece_ptr() info_hash()</a></li>
|
||||
<li><a class="reference internal" href="#name-comment-creation-date-creator" id="id69">name() comment() creation_date() creator()</a></li>
|
||||
<li><a class="reference internal" href="#priv" id="id70">priv()</a></li>
|
||||
<li><a class="reference internal" href="#nodes" id="id71">nodes()</a></li>
|
||||
<li><a class="reference internal" href="#add-node" id="id72">add_node()</a></li>
|
||||
<li><a class="reference internal" href="#metadata-metadata-size" id="id73">metadata() metadata_size()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#torrent-handle" id="id73">torrent_handle</a><ul>
|
||||
<li><a class="reference internal" href="#set-piece-deadline" id="id74">set_piece_deadline()</a></li>
|
||||
<li><a class="reference internal" href="#piece-priority-prioritize-pieces-piece-priorities" id="id75">piece_priority() prioritize_pieces() piece_priorities()</a></li>
|
||||
<li><a class="reference internal" href="#file-priority-prioritize-files-file-priorities" id="id76">file_priority() prioritize_files() file_priorities()</a></li>
|
||||
<li><a class="reference internal" href="#file-progress" id="id77">file_progress()</a></li>
|
||||
<li><a class="reference internal" href="#save-path" id="id78">save_path()</a></li>
|
||||
<li><a class="reference internal" href="#move-storage" id="id79">move_storage()</a></li>
|
||||
<li><a class="reference internal" href="#id5" id="id80">rename_file()</a></li>
|
||||
<li><a class="reference internal" href="#get-storage-impl" id="id81">get_storage_impl()</a></li>
|
||||
<li><a class="reference internal" href="#super-seeding" id="id82">super_seeding()</a></li>
|
||||
<li><a class="reference internal" href="#add-piece" id="id83">add_piece()</a></li>
|
||||
<li><a class="reference internal" href="#read-piece" id="id84">read_piece()</a></li>
|
||||
<li><a class="reference internal" href="#force-reannounce" id="id85">force_reannounce()</a></li>
|
||||
<li><a class="reference internal" href="#scrape-tracker" id="id86">scrape_tracker()</a></li>
|
||||
<li><a class="reference internal" href="#connect-peer" id="id87">connect_peer()</a></li>
|
||||
<li><a class="reference internal" href="#name" id="id88">name()</a></li>
|
||||
<li><a class="reference internal" href="#set-ratio" id="id89">set_ratio()</a></li>
|
||||
<li><a class="reference internal" href="#set-upload-limit-set-download-limit-upload-limit-download-limit" id="id90">set_upload_limit() set_download_limit() upload_limit() download_limit()</a></li>
|
||||
<li><a class="reference internal" href="#set-sequential-download-is-sequential-download" id="id91">set_sequential_download() is_sequential_download()</a></li>
|
||||
<li><a class="reference internal" href="#set-peer-upload-limit-set-peer-download-limit" id="id92">set_peer_upload_limit() set_peer_download_limit()</a></li>
|
||||
<li><a class="reference internal" href="#id6" id="id93">pause() resume() is_paused()</a></li>
|
||||
<li><a class="reference internal" href="#force-recheck" id="id94">force_recheck()</a></li>
|
||||
<li><a class="reference internal" href="#clear-error" id="id95">clear_error()</a></li>
|
||||
<li><a class="reference internal" href="#set-upload-mode" id="id96">set_upload_mode()</a></li>
|
||||
<li><a class="reference internal" href="#resolve-countries" id="id97">resolve_countries()</a></li>
|
||||
<li><a class="reference internal" href="#is-seed" id="id98">is_seed()</a></li>
|
||||
<li><a class="reference internal" href="#is-auto-managed-auto-managed" id="id99">is_auto_managed() auto_managed()</a></li>
|
||||
<li><a class="reference internal" href="#has-metadata-set-metadata" id="id100">has_metadata() set_metadata()</a></li>
|
||||
<li><a class="reference internal" href="#set-tracker-login" id="id101">set_tracker_login()</a></li>
|
||||
<li><a class="reference internal" href="#trackers-replace-trackers-add-tracker" id="id102">trackers() replace_trackers() add_tracker()</a></li>
|
||||
<li><a class="reference internal" href="#add-url-seed-remove-url-seed-url-seeds" id="id103">add_url_seed() remove_url_seed() url_seeds()</a></li>
|
||||
<li><a class="reference internal" href="#add-http-seed-remove-http-seed-http-seeds" id="id104">add_http_seed() remove_http_seed() http_seeds()</a></li>
|
||||
<li><a class="reference internal" href="#queue-position-queue-position-up-queue-position-down-queue-position-top-queue-position-bottom" id="id105">queue_position() queue_position_up() queue_position_down() queue_position_top() queue_position_bottom()</a></li>
|
||||
<li><a class="reference internal" href="#use-interface" id="id106">use_interface()</a></li>
|
||||
<li><a class="reference internal" href="#info-hash" id="id107">info_hash()</a></li>
|
||||
<li><a class="reference internal" href="#set-max-uploads-max-uploads-set-max-connections-max-connections" id="id108">set_max_uploads() max_uploads() set_max_connections() max_connections()</a></li>
|
||||
<li><a class="reference internal" href="#save-resume-data" id="id109">save_resume_data()</a></li>
|
||||
<li><a class="reference internal" href="#id7" id="id110">status()</a></li>
|
||||
<li><a class="reference internal" href="#get-download-queue" id="id111">get_download_queue()</a></li>
|
||||
<li><a class="reference internal" href="#get-peer-info" id="id112">get_peer_info()</a></li>
|
||||
<li><a class="reference internal" href="#get-torrent-info" id="id113">get_torrent_info()</a></li>
|
||||
<li><a class="reference internal" href="#is-valid" id="id114">is_valid()</a></li>
|
||||
<li><a class="reference internal" href="#torrent-handle" id="id74">torrent_handle</a><ul>
|
||||
<li><a class="reference internal" href="#set-piece-deadline" id="id75">set_piece_deadline()</a></li>
|
||||
<li><a class="reference internal" href="#piece-priority-prioritize-pieces-piece-priorities" id="id76">piece_priority() prioritize_pieces() piece_priorities()</a></li>
|
||||
<li><a class="reference internal" href="#file-priority-prioritize-files-file-priorities" id="id77">file_priority() prioritize_files() file_priorities()</a></li>
|
||||
<li><a class="reference internal" href="#file-progress" id="id78">file_progress()</a></li>
|
||||
<li><a class="reference internal" href="#save-path" id="id79">save_path()</a></li>
|
||||
<li><a class="reference internal" href="#move-storage" id="id80">move_storage()</a></li>
|
||||
<li><a class="reference internal" href="#id5" id="id81">rename_file()</a></li>
|
||||
<li><a class="reference internal" href="#get-storage-impl" id="id82">get_storage_impl()</a></li>
|
||||
<li><a class="reference internal" href="#super-seeding" id="id83">super_seeding()</a></li>
|
||||
<li><a class="reference internal" href="#add-piece" id="id84">add_piece()</a></li>
|
||||
<li><a class="reference internal" href="#read-piece" id="id85">read_piece()</a></li>
|
||||
<li><a class="reference internal" href="#force-reannounce" id="id86">force_reannounce()</a></li>
|
||||
<li><a class="reference internal" href="#scrape-tracker" id="id87">scrape_tracker()</a></li>
|
||||
<li><a class="reference internal" href="#connect-peer" id="id88">connect_peer()</a></li>
|
||||
<li><a class="reference internal" href="#name" id="id89">name()</a></li>
|
||||
<li><a class="reference internal" href="#set-ratio" id="id90">set_ratio()</a></li>
|
||||
<li><a class="reference internal" href="#set-upload-limit-set-download-limit-upload-limit-download-limit" id="id91">set_upload_limit() set_download_limit() upload_limit() download_limit()</a></li>
|
||||
<li><a class="reference internal" href="#set-sequential-download-is-sequential-download" id="id92">set_sequential_download() is_sequential_download()</a></li>
|
||||
<li><a class="reference internal" href="#set-peer-upload-limit-set-peer-download-limit" id="id93">set_peer_upload_limit() set_peer_download_limit()</a></li>
|
||||
<li><a class="reference internal" href="#id6" id="id94">pause() resume() is_paused()</a></li>
|
||||
<li><a class="reference internal" href="#force-recheck" id="id95">force_recheck()</a></li>
|
||||
<li><a class="reference internal" href="#clear-error" id="id96">clear_error()</a></li>
|
||||
<li><a class="reference internal" href="#set-upload-mode" id="id97">set_upload_mode()</a></li>
|
||||
<li><a class="reference internal" href="#resolve-countries" id="id98">resolve_countries()</a></li>
|
||||
<li><a class="reference internal" href="#is-seed" id="id99">is_seed()</a></li>
|
||||
<li><a class="reference internal" href="#is-auto-managed-auto-managed" id="id100">is_auto_managed() auto_managed()</a></li>
|
||||
<li><a class="reference internal" href="#has-metadata-set-metadata" id="id101">has_metadata() set_metadata()</a></li>
|
||||
<li><a class="reference internal" href="#set-tracker-login" id="id102">set_tracker_login()</a></li>
|
||||
<li><a class="reference internal" href="#trackers-replace-trackers-add-tracker" id="id103">trackers() replace_trackers() add_tracker()</a></li>
|
||||
<li><a class="reference internal" href="#add-url-seed-remove-url-seed-url-seeds" id="id104">add_url_seed() remove_url_seed() url_seeds()</a></li>
|
||||
<li><a class="reference internal" href="#add-http-seed-remove-http-seed-http-seeds" id="id105">add_http_seed() remove_http_seed() http_seeds()</a></li>
|
||||
<li><a class="reference internal" href="#queue-position-queue-position-up-queue-position-down-queue-position-top-queue-position-bottom" id="id106">queue_position() queue_position_up() queue_position_down() queue_position_top() queue_position_bottom()</a></li>
|
||||
<li><a class="reference internal" href="#set-priority" id="id107">set_priority()</a></li>
|
||||
<li><a class="reference internal" href="#use-interface" id="id108">use_interface()</a></li>
|
||||
<li><a class="reference internal" href="#info-hash" id="id109">info_hash()</a></li>
|
||||
<li><a class="reference internal" href="#set-max-uploads-max-uploads-set-max-connections-max-connections" id="id110">set_max_uploads() max_uploads() set_max_connections() max_connections()</a></li>
|
||||
<li><a class="reference internal" href="#save-resume-data" id="id111">save_resume_data()</a></li>
|
||||
<li><a class="reference internal" href="#id7" id="id112">status()</a></li>
|
||||
<li><a class="reference internal" href="#get-download-queue" id="id113">get_download_queue()</a></li>
|
||||
<li><a class="reference internal" href="#get-peer-info" id="id114">get_peer_info()</a></li>
|
||||
<li><a class="reference internal" href="#get-torrent-info" id="id115">get_torrent_info()</a></li>
|
||||
<li><a class="reference internal" href="#is-valid" id="id116">is_valid()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#torrent-status" id="id115">torrent_status</a></li>
|
||||
<li><a class="reference internal" href="#peer-info" id="id116">peer_info</a></li>
|
||||
<li><a class="reference internal" href="#session-customization" id="id117">session customization</a><ul>
|
||||
<li><a class="reference internal" href="#presets" id="id118">presets</a></li>
|
||||
<li><a class="reference internal" href="#session-settings" id="id119">session_settings</a></li>
|
||||
<li><a class="reference internal" href="#torrent-status" id="id117">torrent_status</a></li>
|
||||
<li><a class="reference internal" href="#peer-info" id="id118">peer_info</a></li>
|
||||
<li><a class="reference internal" href="#session-customization" id="id119">session customization</a><ul>
|
||||
<li><a class="reference internal" href="#presets" id="id120">presets</a></li>
|
||||
<li><a class="reference internal" href="#session-settings" id="id121">session_settings</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#pe-settings" id="id120">pe_settings</a></li>
|
||||
<li><a class="reference internal" href="#proxy-settings" id="id121">proxy_settings</a></li>
|
||||
<li><a class="reference internal" href="#ip-filter" id="id122">ip_filter</a><ul>
|
||||
<li><a class="reference internal" href="#id10" id="id123">ip_filter()</a></li>
|
||||
<li><a class="reference internal" href="#add-rule" id="id124">add_rule()</a></li>
|
||||
<li><a class="reference internal" href="#access" id="id125">access()</a></li>
|
||||
<li><a class="reference internal" href="#export-filter" id="id126">export_filter()</a></li>
|
||||
<li><a class="reference internal" href="#pe-settings" id="id122">pe_settings</a></li>
|
||||
<li><a class="reference internal" href="#proxy-settings" id="id123">proxy_settings</a></li>
|
||||
<li><a class="reference internal" href="#ip-filter" id="id124">ip_filter</a><ul>
|
||||
<li><a class="reference internal" href="#id10" id="id125">ip_filter()</a></li>
|
||||
<li><a class="reference internal" href="#add-rule" id="id126">add_rule()</a></li>
|
||||
<li><a class="reference internal" href="#access" id="id127">access()</a></li>
|
||||
<li><a class="reference internal" href="#export-filter" id="id128">export_filter()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#big-number" id="id127">big_number</a></li>
|
||||
<li><a class="reference internal" href="#bitfield" id="id128">bitfield</a></li>
|
||||
<li><a class="reference internal" href="#hasher" id="id129">hasher</a></li>
|
||||
<li><a class="reference internal" href="#fingerprint" id="id130">fingerprint</a></li>
|
||||
<li><a class="reference internal" href="#upnp-and-nat-pmp" id="id131">UPnP and NAT-PMP</a><ul>
|
||||
<li><a class="reference internal" href="#add-mapping" id="id132">add_mapping</a></li>
|
||||
<li><a class="reference internal" href="#delete-mapping" id="id133">delete_mapping</a></li>
|
||||
<li><a class="reference internal" href="#router-model" id="id134">router_model()</a></li>
|
||||
<li><a class="reference internal" href="#big-number" id="id129">big_number</a></li>
|
||||
<li><a class="reference internal" href="#bitfield" id="id130">bitfield</a></li>
|
||||
<li><a class="reference internal" href="#hasher" id="id131">hasher</a></li>
|
||||
<li><a class="reference internal" href="#fingerprint" id="id132">fingerprint</a></li>
|
||||
<li><a class="reference internal" href="#upnp-and-nat-pmp" id="id133">UPnP and NAT-PMP</a><ul>
|
||||
<li><a class="reference internal" href="#add-mapping" id="id134">add_mapping</a></li>
|
||||
<li><a class="reference internal" href="#delete-mapping" id="id135">delete_mapping</a></li>
|
||||
<li><a class="reference internal" href="#router-model" id="id136">router_model()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#free-functions" id="id135">free functions</a><ul>
|
||||
<li><a class="reference internal" href="#identify-client" id="id136">identify_client()</a></li>
|
||||
<li><a class="reference internal" href="#client-fingerprint" id="id137">client_fingerprint()</a></li>
|
||||
<li><a class="reference internal" href="#bdecode-bencode" id="id138">bdecode() bencode()</a></li>
|
||||
<li><a class="reference internal" href="#add-magnet-uri" id="id139">add_magnet_uri()</a></li>
|
||||
<li><a class="reference internal" href="#make-magnet-uri" id="id140">make_magnet_uri()</a></li>
|
||||
<li><a class="reference internal" href="#free-functions" id="id137">free functions</a><ul>
|
||||
<li><a class="reference internal" href="#identify-client" id="id138">identify_client()</a></li>
|
||||
<li><a class="reference internal" href="#client-fingerprint" id="id139">client_fingerprint()</a></li>
|
||||
<li><a class="reference internal" href="#bdecode-bencode" id="id140">bdecode() bencode()</a></li>
|
||||
<li><a class="reference internal" href="#add-magnet-uri" id="id141">add_magnet_uri()</a></li>
|
||||
<li><a class="reference internal" href="#make-magnet-uri" id="id142">make_magnet_uri()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#alerts" id="id141">alerts</a><ul>
|
||||
<li><a class="reference internal" href="#read-piece-alert" id="id142">read_piece_alert</a></li>
|
||||
<li><a class="reference internal" href="#external-ip-alert" id="id143">external_ip_alert</a></li>
|
||||
<li><a class="reference internal" href="#listen-failed-alert" id="id144">listen_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#portmap-error-alert" id="id145">portmap_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#portmap-alert" id="id146">portmap_alert</a></li>
|
||||
<li><a class="reference internal" href="#portmap-log-alert" id="id147">portmap_log_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-error-alert" id="id148">file_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-renamed-alert" id="id149">file_renamed_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-rename-failed-alert" id="id150">file_rename_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-announce-alert" id="id151">tracker_announce_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-error-alert" id="id152">tracker_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-reply-alert" id="id153">tracker_reply_alert</a></li>
|
||||
<li><a class="reference internal" href="#dht-reply-alert" id="id154">dht_reply_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-warning-alert" id="id155">tracker_warning_alert</a></li>
|
||||
<li><a class="reference internal" href="#scrape-reply-alert" id="id156">scrape_reply_alert</a></li>
|
||||
<li><a class="reference internal" href="#scrape-failed-alert" id="id157">scrape_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#url-seed-alert" id="id158">url_seed_alert</a></li>
|
||||
<li><a class="reference internal" href="#hash-failed-alert" id="id159">hash_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-alert" id="id160">peer_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-ban-alert" id="id161">peer_ban_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-snubbed-alert" id="id162">peer_snubbed_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-unsnubbed-alert" id="id163">peer_unsnubbed_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-error-alert" id="id164">peer_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-connected-alert" id="id165">peer_connected_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-disconnected-alert" id="id166">peer_disconnected_alert</a></li>
|
||||
<li><a class="reference internal" href="#invalid-request-alert" id="id167">invalid_request_alert</a></li>
|
||||
<li><a class="reference internal" href="#request-dropped-alert" id="id168">request_dropped_alert</a></li>
|
||||
<li><a class="reference internal" href="#block-timeout-alert" id="id169">block_timeout_alert</a></li>
|
||||
<li><a class="reference internal" href="#block-finished-alert" id="id170">block_finished_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-completed-alert" id="id171">file_completed_alert</a></li>
|
||||
<li><a class="reference internal" href="#block-downloading-alert" id="id172">block_downloading_alert</a></li>
|
||||
<li><a class="reference internal" href="#unwanted-block-alert" id="id173">unwanted_block_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-delete-failed-alert" id="id174">torrent_delete_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-finished-alert" id="id175">torrent_finished_alert</a></li>
|
||||
<li><a class="reference internal" href="#performance-alert" id="id176">performance_alert</a></li>
|
||||
<li><a class="reference internal" href="#state-changed-alert" id="id177">state_changed_alert</a></li>
|
||||
<li><a class="reference internal" href="#metadata-failed-alert" id="id178">metadata_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#metadata-received-alert" id="id179">metadata_received_alert</a></li>
|
||||
<li><a class="reference internal" href="#fastresume-rejected-alert" id="id180">fastresume_rejected_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-blocked-alert" id="id181">peer_blocked_alert</a></li>
|
||||
<li><a class="reference internal" href="#storage-moved-alert" id="id182">storage_moved_alert</a></li>
|
||||
<li><a class="reference internal" href="#storage-moved-failed-alert" id="id183">storage_moved_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-paused-alert" id="id184">torrent_paused_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-resumed-alert" id="id185">torrent_resumed_alert</a></li>
|
||||
<li><a class="reference internal" href="#save-resume-data-alert" id="id186">save_resume_data_alert</a></li>
|
||||
<li><a class="reference internal" href="#save-resume-data-failed-alert" id="id187">save_resume_data_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#dht-announce-alert" id="id188">dht_announce_alert</a></li>
|
||||
<li><a class="reference internal" href="#dht-get-peers-alert" id="id189">dht_get_peers_alert</a></li>
|
||||
<li><a class="reference internal" href="#dispatcher" id="id190">dispatcher</a></li>
|
||||
<li><a class="reference internal" href="#alerts" id="id143">alerts</a><ul>
|
||||
<li><a class="reference internal" href="#read-piece-alert" id="id144">read_piece_alert</a></li>
|
||||
<li><a class="reference internal" href="#external-ip-alert" id="id145">external_ip_alert</a></li>
|
||||
<li><a class="reference internal" href="#listen-failed-alert" id="id146">listen_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#listen-succeeded-alert" id="id147">listen_succeeded_alert</a></li>
|
||||
<li><a class="reference internal" href="#portmap-error-alert" id="id148">portmap_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#portmap-alert" id="id149">portmap_alert</a></li>
|
||||
<li><a class="reference internal" href="#portmap-log-alert" id="id150">portmap_log_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-error-alert" id="id151">file_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-renamed-alert" id="id152">file_renamed_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-rename-failed-alert" id="id153">file_rename_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-announce-alert" id="id154">tracker_announce_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-error-alert" id="id155">tracker_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-reply-alert" id="id156">tracker_reply_alert</a></li>
|
||||
<li><a class="reference internal" href="#dht-reply-alert" id="id157">dht_reply_alert</a></li>
|
||||
<li><a class="reference internal" href="#tracker-warning-alert" id="id158">tracker_warning_alert</a></li>
|
||||
<li><a class="reference internal" href="#scrape-reply-alert" id="id159">scrape_reply_alert</a></li>
|
||||
<li><a class="reference internal" href="#scrape-failed-alert" id="id160">scrape_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#url-seed-alert" id="id161">url_seed_alert</a></li>
|
||||
<li><a class="reference internal" href="#hash-failed-alert" id="id162">hash_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-alert" id="id163">peer_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-connect-alert" id="id164">peer_connect_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-ban-alert" id="id165">peer_ban_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-snubbed-alert" id="id166">peer_snubbed_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-unsnubbed-alert" id="id167">peer_unsnubbed_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-error-alert" id="id168">peer_error_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-connected-alert" id="id169">peer_connected_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-disconnected-alert" id="id170">peer_disconnected_alert</a></li>
|
||||
<li><a class="reference internal" href="#invalid-request-alert" id="id171">invalid_request_alert</a></li>
|
||||
<li><a class="reference internal" href="#request-dropped-alert" id="id172">request_dropped_alert</a></li>
|
||||
<li><a class="reference internal" href="#block-timeout-alert" id="id173">block_timeout_alert</a></li>
|
||||
<li><a class="reference internal" href="#block-finished-alert" id="id174">block_finished_alert</a></li>
|
||||
<li><a class="reference internal" href="#file-completed-alert" id="id175">file_completed_alert</a></li>
|
||||
<li><a class="reference internal" href="#block-downloading-alert" id="id176">block_downloading_alert</a></li>
|
||||
<li><a class="reference internal" href="#unwanted-block-alert" id="id177">unwanted_block_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-delete-failed-alert" id="id178">torrent_delete_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-finished-alert" id="id179">torrent_finished_alert</a></li>
|
||||
<li><a class="reference internal" href="#performance-alert" id="id180">performance_alert</a></li>
|
||||
<li><a class="reference internal" href="#state-changed-alert" id="id181">state_changed_alert</a></li>
|
||||
<li><a class="reference internal" href="#metadata-failed-alert" id="id182">metadata_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#metadata-received-alert" id="id183">metadata_received_alert</a></li>
|
||||
<li><a class="reference internal" href="#fastresume-rejected-alert" id="id184">fastresume_rejected_alert</a></li>
|
||||
<li><a class="reference internal" href="#peer-blocked-alert" id="id185">peer_blocked_alert</a></li>
|
||||
<li><a class="reference internal" href="#storage-moved-alert" id="id186">storage_moved_alert</a></li>
|
||||
<li><a class="reference internal" href="#storage-moved-failed-alert" id="id187">storage_moved_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-paused-alert" id="id188">torrent_paused_alert</a></li>
|
||||
<li><a class="reference internal" href="#torrent-resumed-alert" id="id189">torrent_resumed_alert</a></li>
|
||||
<li><a class="reference internal" href="#save-resume-data-alert" id="id190">save_resume_data_alert</a></li>
|
||||
<li><a class="reference internal" href="#save-resume-data-failed-alert" id="id191">save_resume_data_failed_alert</a></li>
|
||||
<li><a class="reference internal" href="#dht-announce-alert" id="id192">dht_announce_alert</a></li>
|
||||
<li><a class="reference internal" href="#dht-get-peers-alert" id="id193">dht_get_peers_alert</a></li>
|
||||
<li><a class="reference internal" href="#dispatcher" id="id194">dispatcher</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#exceptions" id="id191">exceptions</a><ul>
|
||||
<li><a class="reference internal" href="#libtorrent-exception" id="id192">libtorrent_exception</a></li>
|
||||
<li><a class="reference internal" href="#exceptions" id="id195">exceptions</a><ul>
|
||||
<li><a class="reference internal" href="#libtorrent-exception" id="id196">libtorrent_exception</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#error-code" id="id193">error_code</a><ul>
|
||||
<li><a class="reference internal" href="#translating-error-codes" id="id194">translating error codes</a></li>
|
||||
<li><a class="reference internal" href="#error-code" id="id197">error_code</a><ul>
|
||||
<li><a class="reference internal" href="#translating-error-codes" id="id198">translating error codes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#storage-interface" id="id195">storage_interface</a><ul>
|
||||
<li><a class="reference internal" href="#initialize" id="id196">initialize()</a></li>
|
||||
<li><a class="reference internal" href="#has-any-file" id="id197">has_any_file()</a></li>
|
||||
<li><a class="reference internal" href="#readv-writev" id="id198">readv() writev()</a></li>
|
||||
<li><a class="reference internal" href="#sparse-end" id="id199">sparse_end()</a></li>
|
||||
<li><a class="reference internal" href="#id12" id="id200">move_storage()</a></li>
|
||||
<li><a class="reference internal" href="#verify-resume-data" id="id201">verify_resume_data()</a></li>
|
||||
<li><a class="reference internal" href="#write-resume-data" id="id202">write_resume_data()</a></li>
|
||||
<li><a class="reference internal" href="#move-slot" id="id203">move_slot()</a></li>
|
||||
<li><a class="reference internal" href="#swap-slots" id="id204">swap_slots()</a></li>
|
||||
<li><a class="reference internal" href="#swap-slots3" id="id205">swap_slots3()</a></li>
|
||||
<li><a class="reference internal" href="#id13" id="id206">rename_file()</a></li>
|
||||
<li><a class="reference internal" href="#release-files" id="id207">release_files()</a></li>
|
||||
<li><a class="reference internal" href="#delete-files" id="id208">delete_files()</a></li>
|
||||
<li><a class="reference internal" href="#storage-interface" id="id199">storage_interface</a><ul>
|
||||
<li><a class="reference internal" href="#initialize" id="id200">initialize()</a></li>
|
||||
<li><a class="reference internal" href="#has-any-file" id="id201">has_any_file()</a></li>
|
||||
<li><a class="reference internal" href="#readv-writev" id="id202">readv() writev()</a></li>
|
||||
<li><a class="reference internal" href="#sparse-end" id="id203">sparse_end()</a></li>
|
||||
<li><a class="reference internal" href="#id12" id="id204">move_storage()</a></li>
|
||||
<li><a class="reference internal" href="#verify-resume-data" id="id205">verify_resume_data()</a></li>
|
||||
<li><a class="reference internal" href="#write-resume-data" id="id206">write_resume_data()</a></li>
|
||||
<li><a class="reference internal" href="#move-slot" id="id207">move_slot()</a></li>
|
||||
<li><a class="reference internal" href="#swap-slots" id="id208">swap_slots()</a></li>
|
||||
<li><a class="reference internal" href="#swap-slots3" id="id209">swap_slots3()</a></li>
|
||||
<li><a class="reference internal" href="#id13" id="id210">rename_file()</a></li>
|
||||
<li><a class="reference internal" href="#release-files" id="id211">release_files()</a></li>
|
||||
<li><a class="reference internal" href="#delete-files" id="id212">delete_files()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#magnet-links" id="id209">magnet links</a></li>
|
||||
<li><a class="reference internal" href="#queuing" id="id210">queuing</a><ul>
|
||||
<li><a class="reference internal" href="#downloading" id="id211">downloading</a></li>
|
||||
<li><a class="reference internal" href="#seeding" id="id212">seeding</a></li>
|
||||
<li><a class="reference internal" href="#magnet-links" id="id213">magnet links</a></li>
|
||||
<li><a class="reference internal" href="#queuing" id="id214">queuing</a><ul>
|
||||
<li><a class="reference internal" href="#downloading" id="id215">downloading</a></li>
|
||||
<li><a class="reference internal" href="#seeding" id="id216">seeding</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#fast-resume" id="id213">fast resume</a><ul>
|
||||
<li><a class="reference internal" href="#file-format" id="id214">file format</a></li>
|
||||
<li><a class="reference internal" href="#fast-resume" id="id217">fast resume</a><ul>
|
||||
<li><a class="reference internal" href="#file-format" id="id218">file format</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#threads" id="id215">threads</a></li>
|
||||
<li><a class="reference internal" href="#storage-allocation" id="id216">storage allocation</a><ul>
|
||||
<li><a class="reference internal" href="#sparse-allocation" id="id217">sparse allocation</a></li>
|
||||
<li><a class="reference internal" href="#full-allocation" id="id218">full allocation</a></li>
|
||||
<li><a class="reference internal" href="#compact-allocation" id="id219">compact allocation</a></li>
|
||||
<li><a class="reference internal" href="#threads" id="id219">threads</a></li>
|
||||
<li><a class="reference internal" href="#storage-allocation" id="id220">storage allocation</a><ul>
|
||||
<li><a class="reference internal" href="#sparse-allocation" id="id221">sparse allocation</a></li>
|
||||
<li><a class="reference internal" href="#full-allocation" id="id222">full allocation</a></li>
|
||||
<li><a class="reference internal" href="#compact-allocation" id="id223">compact allocation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#extensions" id="id220">extensions</a><ul>
|
||||
<li><a class="reference internal" href="#metadata-from-peers" id="id221">metadata from peers</a></li>
|
||||
<li><a class="reference internal" href="#http-seeding" id="id222">HTTP seeding</a></li>
|
||||
<li><a class="reference internal" href="#extensions" id="id224">extensions</a><ul>
|
||||
<li><a class="reference internal" href="#metadata-from-peers" id="id225">metadata from peers</a></li>
|
||||
<li><a class="reference internal" href="#http-seeding" id="id226">HTTP seeding</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#filename-checks" id="id223">filename checks</a></li>
|
||||
<li><a class="reference internal" href="#filename-checks" id="id227">filename checks</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="overview">
|
||||
@@ -1123,9 +1127,12 @@ The alert is not popped, any subsequent calls to <tt class="docutils literal"><s
|
||||
same pointer until the alert is popped by calling <tt class="docutils literal"><span class="pre">pop_alert</span></tt>. This is useful for
|
||||
leaving any alert dispatching mechanism independent of this blocking call, the dispatcher
|
||||
can be called and it can pop the alert independently.</p>
|
||||
<p>In the python binding, <tt class="docutils literal"><span class="pre">wait_for_alert</span></tt> takes the number of milliseconds to wait as an integer.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">set_alert_queue_size_limit()</span></tt> 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 <tt class="docutils literal"><span class="pre">pop_alert</span></tt>. Default value is 1000.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">save_resume_data_alert</span></tt> and <tt class="docutils literal"><span class="pre">save_resume_data_failed_alert</span></tt> are always posted, regardelss
|
||||
of the alert mask.</p>
|
||||
</div>
|
||||
<div class="section" id="add-extension">
|
||||
<h2>add_extension()</h2>
|
||||
@@ -1224,6 +1231,19 @@ proxy_settings const& dht_proxy() const;
|
||||
<p>These functions returns references to their respective current settings.</p>
|
||||
<p>The <tt class="docutils literal"><span class="pre">dht_proxy</span></tt> is not available when DHT is disabled.</p>
|
||||
</div>
|
||||
<div class="section" id="set-i2p-proxy-i2p-proxy">
|
||||
<h2>set_i2p_proxy() i2p_proxy()</h2>
|
||||
<blockquote>
|
||||
<pre class="literal-block">
|
||||
void set_i2p_proxy(proxy_settings const&);
|
||||
proxy_settings const& i2p_proxy();
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p><tt class="docutils literal"><span class="pre">set_i2p_proxy</span></tt> sets the <a class="reference external" href="http://www.i2p2.de">i2p</a> proxy, and tries to open a persistant
|
||||
connection to it. The only used fields in the proxy settings structs
|
||||
are <tt class="docutils literal"><span class="pre">hostname</span></tt> and <tt class="docutils literal"><span class="pre">port</span></tt>.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">i2p_proxy</span></tt> returns the current i2p proxy in use.</p>
|
||||
</div>
|
||||
<div class="section" id="start-dht-stop-dht-set-dht-settings-dht-state">
|
||||
<h2>start_dht() stop_dht() set_dht_settings() dht_state()</h2>
|
||||
<blockquote>
|
||||
@@ -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 <tt class="docutils literal"><span class="
|
||||
<p>If the piece is already downloaded when this call is made, nothing happens, unless
|
||||
the <tt class="docutils literal"><span class="pre">alert_when_available</span></tt> flag is set, in which case it will do the same thing
|
||||
as calling <a class="reference internal" href="#read-piece">read_piece()</a> for <tt class="docutils literal"><span class="pre">index</span></tt>.</p>
|
||||
<p>In the python binding for this function, the <tt class="docutils literal"><span class="pre">deadline</span></tt> is the number of milliseconds
|
||||
as an integer.</p>
|
||||
</div>
|
||||
<div class="section" id="piece-priority-prioritize-pieces-piece-priorities">
|
||||
<h2>piece_priority() prioritize_pieces() piece_priorities()</h2>
|
||||
@@ -2557,6 +2581,23 @@ the closer the torrent is to the front of the line to be started.</p>
|
||||
closer to the front and down means closer to the back of the queue. Top and bottom refers
|
||||
to the front and the back of the queue respectively.</p>
|
||||
</div>
|
||||
<div class="section" id="set-priority">
|
||||
<h2>set_priority()</h2>
|
||||
<blockquote>
|
||||
<pre class="literal-block">
|
||||
void set_priority(int prio) const;
|
||||
</pre>
|
||||
</blockquote>
|
||||
<p>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].</p>
|
||||
<p>The default priority is 0, which is the lowest priority.</p>
|
||||
<p>To query the priority of a torrent, use the <a href="#id228"><span class="problematic" id="id229">`status()`_</span></a> call.</p>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
<div class="section" id="use-interface">
|
||||
<h2>use_interface()</h2>
|
||||
<blockquote>
|
||||
@@ -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;
|
||||
};
|
||||
</pre>
|
||||
<p><tt class="docutils literal"><span class="pre">progress</span></tt> is a value in the range [0, 1], that represents the progress of the
|
||||
@@ -3068,11 +3112,12 @@ the <tt class="docutils literal"><span class="pre">session_status</span></tt> ob
|
||||
<p><tt class="docutils literal"><span class="pre">all_time_upload</span></tt> and <tt class="docutils literal"><span class="pre">all_time_download</span></tt> are accumulated upload and download
|
||||
payload byte counters. They are saved in and restored from resume data to keep totals
|
||||
across sessions.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">active_time</span></tt> and <tt class="docutils literal"><span class="pre">seeding_time</span></tt> 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. <tt class="docutils literal"><span class="pre">seeding_time</span></tt> should be >=
|
||||
<tt class="docutils literal"><span class="pre">active_time</span></tt> They are saved in and restored from resume data, to keep totals
|
||||
across sessions.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">active_time</span></tt>, <tt class="docutils literal"><span class="pre">finished_time</span></tt> and <tt class="docutils literal"><span class="pre">seeding_time</span></tt> 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. <tt class="docutils literal"><span class="pre">seeding_time</span></tt> should be >= <tt class="docutils literal"><span class="pre">finished_time</span></tt> which
|
||||
should be >= <tt class="docutils literal"><span class="pre">active_time</span></tt>. They are all saved in and restored from resume data,
|
||||
to keep totals across sessions.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">seed_rank</span></tt> 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 <a class="reference internal" href="#queuing">queuing</a>.</p>
|
||||
@@ -3564,6 +3609,8 @@ struct session_settings
|
||||
|
||||
int optimistic_disk_retry;
|
||||
bool disable_hash_check;
|
||||
|
||||
int max_suggest_pieces;
|
||||
};
|
||||
</pre>
|
||||
<p><tt class="docutils literal"><span class="pre">user_agent</span></tt> 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.</
|
||||
<p><tt class="docutils literal"><span class="pre">handshake_timeout</span></tt> 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.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">use_dht_as_fallback</span></tt> 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.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">use_dht_as_fallback</span></tt> 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.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">free_torrent_hashes</span></tt> 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
|
||||
<tt class="docutils literal"><span class="pre">true</span></tt> 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.</p>
|
||||
<p><tt class="docutils literal"><span class="pre">max_suggest_pieces</span></tt> 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.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="pe-settings">
|
||||
@@ -4608,8 +4659,30 @@ struct external_ip_alert: alert
|
||||
<div class="section" id="listen-failed-alert">
|
||||
<h2>listen_failed_alert</h2>
|
||||
<p>This alert is generated when none of the ports, given in the port range, to
|
||||
<a class="reference internal" href="#session">session</a> can be opened for listening. This alert doesn't have any extra
|
||||
data members.</p>
|
||||
<a class="reference internal" href="#session">session</a> can be opened for listening. The <tt class="docutils literal"><span class="pre">endpoint</span></tt> member is the
|
||||
interface and port that failed, <tt class="docutils literal"><span class="pre">error</span></tt> is the error code describing
|
||||
the failure.</p>
|
||||
<pre class="literal-block">
|
||||
struct listen_failed_alert: alert
|
||||
{
|
||||
// ...
|
||||
tcp::endpoint endpoint;
|
||||
error_code error;
|
||||
};
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="listen-succeeded-alert">
|
||||
<h2>listen_succeeded_alert</h2>
|
||||
<p>This alert is posted when the listen port succeeds to be opened on a
|
||||
particular interface. <tt class="docutils literal"><span class="pre">endpoint</span></tt> is the endpoint that successfully
|
||||
was opened for listening.</p>
|
||||
<pre class="literal-block">
|
||||
struct listen_succeeded_alert: alert
|
||||
{
|
||||
// ...
|
||||
tcp::endpoint endpoint;
|
||||
};
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="portmap-error-alert">
|
||||
<h2>portmap_error_alert</h2>
|
||||
@@ -4858,6 +4931,16 @@ struct peer_alert: torrent_alert
|
||||
};
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="peer-connect-alert">
|
||||
<h2>peer_connect_alert</h2>
|
||||
<p>This alert is posted every time an outgoing peer connect attempts succeeds.</p>
|
||||
<pre class="literal-block">
|
||||
struct peer_connect_alert: peer_alert
|
||||
{
|
||||
// ...
|
||||
};
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="peer-ban-alert">
|
||||
<h2>peer_ban_alert</h2>
|
||||
<p>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
|
||||
<p>This alert is generated when a peer is blocked by the IP filter. The <tt class="docutils literal"><span class="pre">ip</span></tt> member is the
|
||||
address that was blocked.</p>
|
||||
<pre class="literal-block">
|
||||
struct peer_blocked_alert: alert
|
||||
struct peer_blocked_alert: torrent_alert
|
||||
{
|
||||
// ...
|
||||
address ip;
|
||||
@@ -5217,17 +5301,17 @@ struct dht_get_peers_alert: alert
|
||||
<pre class="literal-block">
|
||||
struct 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.</p>
|
||||
<p>Before moving the files, any open file handles may have to be closed, like
|
||||
<tt class="docutils literal"><span class="pre">release_files()</span></tt>.</p>
|
||||
<p>Returning <tt class="docutils literal"><span class="pre">true</span></tt> indicates an error occurred.</p>
|
||||
<p>Returning <tt class="docutils literal"><span class="pre">false</span></tt> indicates an error occurred.</p>
|
||||
</div>
|
||||
<div class="section" id="verify-resume-data">
|
||||
<h2>verify_resume_data()</h2>
|
||||
@@ -6772,6 +6856,12 @@ altogether. You can use:</p>
|
||||
boost::filesystem::path::default_name_check(boost::filesystem::native);
|
||||
</pre>
|
||||
<p>for example. For more information, see the <a class="reference external" href="http://www.boost.org/libs/filesystem/doc/index.htm">Boost.Filesystem docs</a>.</p>
|
||||
</div>
|
||||
<div class="system-messages section">
|
||||
<h1>Docutils System Messages</h1>
|
||||
<div class="system-message" id="id228">
|
||||
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 2534); <em><a href="#id229">backlink</a></em></p>
|
||||
Duplicate target name, cannot be used as a unique reference: "status()".</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="footer">
|
||||
|
Reference in New Issue
Block a user