regenerated html

This commit is contained in:
Arvid Norberg 2008-11-30 07:59:29 +00:00
parent a10db6dad7
commit 58b3061f11
1 changed files with 238 additions and 184 deletions

View File

@ -44,214 +44,215 @@
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of contents</p>
<ul class="simple">
<li><a class="reference internal" href="#overview" id="id17">overview</a></li>
<li><a class="reference internal" href="#network-primitives" id="id18">network primitives</a></li>
<li><a class="reference internal" href="#session" id="id19">session</a><ul>
<li><a class="reference internal" href="#id1" id="id20">session()</a></li>
<li><a class="reference internal" href="#id2" id="id21">~session()</a></li>
<li><a class="reference internal" href="#pause-resume-is-paused" id="id22">pause() resume() is_paused()</a></li>
<li><a class="reference internal" href="#abort" id="id23">abort()</a></li>
<li><a class="reference internal" href="#add-torrent" id="id24">add_torrent()</a></li>
<li><a class="reference internal" href="#remove-torrent" id="id25">remove_torrent()</a></li>
<li><a class="reference internal" href="#find-torrent-get-torrents" id="id26">find_torrent() get_torrents()</a></li>
<li><a class="reference internal" href="#set-upload-rate-limit-set-download-rate-limit-upload-rate-limit-download-rate-limit" id="id27">set_upload_rate_limit() set_download_rate_limit() upload_rate_limit() download_rate_limit()</a></li>
<li><a class="reference internal" href="#set-max-uploads-set-max-connections-max-connections" id="id28">set_max_uploads() set_max_connections() max_connections()</a></li>
<li><a class="reference internal" href="#num-uploads-num-connections" id="id29">num_uploads() num_connections()</a></li>
<li><a class="reference internal" href="#set-max-half-open-connections-max-half-open-connections" id="id30">set_max_half_open_connections() max_half_open_connections()</a></li>
<li><a class="reference internal" href="#load-asnum-db-load-country-db-int-as-for-ip" id="id31">load_asnum_db() load_country_db() int as_for_ip()</a></li>
<li><a class="reference internal" href="#load-state-state" id="id32">load_state() state()</a></li>
<li><a class="reference internal" href="#set-ip-filter" id="id33">set_ip_filter()</a></li>
<li><a class="reference internal" href="#status" id="id34">status()</a></li>
<li><a class="reference internal" href="#get-cache-status" id="id35">get_cache_status()</a></li>
<li><a class="reference internal" href="#get-cache-info" id="id36">get_cache_info()</a></li>
<li><a class="reference internal" href="#is-listening-listen-port-listen-on" id="id37">is_listening() listen_port() listen_on()</a></li>
<li><a class="reference internal" href="#pop-alert-set-alert-mask-wait-for-alert-set-alert-queue-size-limit" id="id38">pop_alert() set_alert_mask() wait_for_alert() set_alert_queue_size_limit()</a></li>
<li><a class="reference internal" href="#add-extension" id="id39">add_extension()</a></li>
<li><a class="reference internal" href="#set-settings-set-pe-settings" id="id40">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="id41">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="id42">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="id43">start_dht() stop_dht() set_dht_settings() dht_state()</a></li>
<li><a class="reference internal" href="#add-dht-node-add-dht-router" id="id44">add_dht_node() add_dht_router()</a></li>
<li><a class="reference internal" href="#start-lsd-stop-lsd" id="id45">start_lsd() stop_lsd()</a></li>
<li><a class="reference internal" href="#start-upnp-stop-upnp" id="id46">start_upnp() stop_upnp()</a></li>
<li><a class="reference internal" href="#start-natpmp-stop-natpmp" id="id47">start_natpmp() stop_natpmp()</a></li>
<li><a class="reference internal" href="#overview" id="id18">overview</a></li>
<li><a class="reference internal" href="#network-primitives" id="id19">network primitives</a></li>
<li><a class="reference internal" href="#session" id="id20">session</a><ul>
<li><a class="reference internal" href="#id1" id="id21">session()</a></li>
<li><a class="reference internal" href="#id2" id="id22">~session()</a></li>
<li><a class="reference internal" href="#pause-resume-is-paused" id="id23">pause() resume() is_paused()</a></li>
<li><a class="reference internal" href="#abort" id="id24">abort()</a></li>
<li><a class="reference internal" href="#add-torrent" id="id25">add_torrent()</a></li>
<li><a class="reference internal" href="#remove-torrent" id="id26">remove_torrent()</a></li>
<li><a class="reference internal" href="#find-torrent-get-torrents" id="id27">find_torrent() get_torrents()</a></li>
<li><a class="reference internal" href="#set-upload-rate-limit-set-download-rate-limit-upload-rate-limit-download-rate-limit" id="id28">set_upload_rate_limit() set_download_rate_limit() upload_rate_limit() download_rate_limit()</a></li>
<li><a class="reference internal" href="#set-max-uploads-set-max-connections-max-connections" id="id29">set_max_uploads() set_max_connections() max_connections()</a></li>
<li><a class="reference internal" href="#num-uploads-num-connections" id="id30">num_uploads() num_connections()</a></li>
<li><a class="reference internal" href="#set-max-half-open-connections-max-half-open-connections" id="id31">set_max_half_open_connections() max_half_open_connections()</a></li>
<li><a class="reference internal" href="#load-asnum-db-load-country-db-int-as-for-ip" id="id32">load_asnum_db() load_country_db() int as_for_ip()</a></li>
<li><a class="reference internal" href="#load-state-state" id="id33">load_state() state()</a></li>
<li><a class="reference internal" href="#set-ip-filter" id="id34">set_ip_filter()</a></li>
<li><a class="reference internal" href="#status" id="id35">status()</a></li>
<li><a class="reference internal" href="#get-cache-status" id="id36">get_cache_status()</a></li>
<li><a class="reference internal" href="#get-cache-info" id="id37">get_cache_info()</a></li>
<li><a class="reference internal" href="#is-listening-listen-port-listen-on" id="id38">is_listening() listen_port() listen_on()</a></li>
<li><a class="reference internal" href="#pop-alert-set-alert-mask-wait-for-alert-set-alert-queue-size-limit" id="id39">pop_alert() set_alert_mask() wait_for_alert() set_alert_queue_size_limit()</a></li>
<li><a class="reference internal" href="#add-extension" id="id40">add_extension()</a></li>
<li><a class="reference internal" href="#set-settings-set-pe-settings" id="id41">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="id42">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="id43">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="id44">start_dht() stop_dht() set_dht_settings() dht_state()</a></li>
<li><a class="reference internal" href="#add-dht-node-add-dht-router" id="id45">add_dht_node() add_dht_router()</a></li>
<li><a class="reference internal" href="#start-lsd-stop-lsd" id="id46">start_lsd() stop_lsd()</a></li>
<li><a class="reference internal" href="#start-upnp-stop-upnp" id="id47">start_upnp() stop_upnp()</a></li>
<li><a class="reference internal" href="#start-natpmp-stop-natpmp" id="id48">start_natpmp() stop_natpmp()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#entry" id="id48">entry</a><ul>
<li><a class="reference internal" href="#integer-string-list-dict-type" id="id49">integer() string() list() dict() type()</a></li>
<li><a class="reference internal" href="#operator" id="id50">operator[]</a></li>
<li><a class="reference internal" href="#find-key" id="id51">find_key()</a></li>
<li><a class="reference internal" href="#entry" id="id49">entry</a><ul>
<li><a class="reference internal" href="#integer-string-list-dict-type" id="id50">integer() string() list() dict() type()</a></li>
<li><a class="reference internal" href="#operator" id="id51">operator[]</a></li>
<li><a class="reference internal" href="#find-key" id="id52">find_key()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#torrent-info" id="id52">torrent_info</a><ul>
<li><a class="reference internal" href="#id3" id="id53">torrent_info()</a></li>
<li><a class="reference internal" href="#add-tracker" id="id54">add_tracker()</a></li>
<li><a class="reference internal" href="#files" id="id55">files()</a></li>
<li><a class="reference internal" href="#begin-files-end-files-rbegin-files-rend-files" id="id56">begin_files() end_files() rbegin_files() rend_files()</a></li>
<li><a class="reference internal" href="#num-files-file-at" id="id57">num_files() file_at()</a></li>
<li><a class="reference internal" href="#map-block" id="id58">map_block()</a></li>
<li><a class="reference internal" href="#map-file" id="id59">map_file()</a></li>
<li><a class="reference internal" href="#url-seeds-add-url-seed" id="id60">url_seeds() add_url_seed()</a></li>
<li><a class="reference internal" href="#trackers" id="id61">trackers()</a></li>
<li><a class="reference internal" href="#total-size-piece-length-piece-size-num-pieces" id="id62">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="id63">hash_for_piece() hash_for_piece_ptr() info_hash()</a></li>
<li><a class="reference internal" href="#name-comment-creation-date-creator" id="id64">name() comment() creation_date() creator()</a></li>
<li><a class="reference internal" href="#priv" id="id65">priv()</a></li>
<li><a class="reference internal" href="#nodes" id="id66">nodes()</a></li>
<li><a class="reference internal" href="#add-node" id="id67">add_node()</a></li>
<li><a class="reference internal" href="#metadata-metadata-size" id="id68">metadata() metadata_size()</a></li>
<li><a class="reference internal" href="#torrent-info" id="id53">torrent_info</a><ul>
<li><a class="reference internal" href="#id3" id="id54">torrent_info()</a></li>
<li><a class="reference internal" href="#add-tracker" id="id55">add_tracker()</a></li>
<li><a class="reference internal" href="#files" id="id56">files()</a></li>
<li><a class="reference internal" href="#begin-files-end-files-rbegin-files-rend-files" id="id57">begin_files() end_files() rbegin_files() rend_files()</a></li>
<li><a class="reference internal" href="#num-files-file-at" id="id58">num_files() file_at()</a></li>
<li><a class="reference internal" href="#map-block" id="id59">map_block()</a></li>
<li><a class="reference internal" href="#map-file" id="id60">map_file()</a></li>
<li><a class="reference internal" href="#url-seeds-add-url-seed" id="id61">url_seeds() add_url_seed()</a></li>
<li><a class="reference internal" href="#trackers" id="id62">trackers()</a></li>
<li><a class="reference internal" href="#total-size-piece-length-piece-size-num-pieces" id="id63">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="id64">hash_for_piece() hash_for_piece_ptr() info_hash()</a></li>
<li><a class="reference internal" href="#name-comment-creation-date-creator" id="id65">name() comment() creation_date() creator()</a></li>
<li><a class="reference internal" href="#priv" id="id66">priv()</a></li>
<li><a class="reference internal" href="#nodes" id="id67">nodes()</a></li>
<li><a class="reference internal" href="#add-node" id="id68">add_node()</a></li>
<li><a class="reference internal" href="#metadata-metadata-size" id="id69">metadata() metadata_size()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#torrent-handle" id="id69">torrent_handle</a><ul>
<li><a class="reference internal" href="#piece-priority-prioritize-pieces-piece-priorities" id="id70">piece_priority() prioritize_pieces() piece_priorities()</a></li>
<li><a class="reference internal" href="#file-priority-prioritize-files-file-priorities" id="id71">file_priority() prioritize_files() file_priorities()</a></li>
<li><a class="reference internal" href="#file-progress" id="id72">file_progress()</a></li>
<li><a class="reference internal" href="#save-path" id="id73">save_path()</a></li>
<li><a class="reference internal" href="#move-storage" id="id74">move_storage()</a></li>
<li><a class="reference internal" href="#get-storage-impl" id="id75">get_storage_impl()</a></li>
<li><a class="reference internal" href="#force-reannounce" id="id76">force_reannounce()</a></li>
<li><a class="reference internal" href="#scrape-tracker" id="id77">scrape_tracker()</a></li>
<li><a class="reference internal" href="#connect-peer" id="id78">connect_peer()</a></li>
<li><a class="reference internal" href="#name" id="id79">name()</a></li>
<li><a class="reference internal" href="#set-ratio" id="id80">set_ratio()</a></li>
<li><a class="reference internal" href="#set-upload-limit-set-download-limit-upload-limit-download-limit" id="id81">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="id82">set_sequential_download() is_sequential_download()</a></li>
<li><a class="reference internal" href="#set-peer-upload-limit-set-peer-download-limit" id="id83">set_peer_upload_limit() set_peer_download_limit()</a></li>
<li><a class="reference internal" href="#id5" id="id84">pause() resume() is_paused()</a></li>
<li><a class="reference internal" href="#force-recheck" id="id85">force_recheck()</a></li>
<li><a class="reference internal" href="#clear-error" id="id86">clear_error()</a></li>
<li><a class="reference internal" href="#resolve-countries" id="id87">resolve_countries()</a></li>
<li><a class="reference internal" href="#is-seed" id="id88">is_seed()</a></li>
<li><a class="reference internal" href="#is-auto-managed-auto-managed" id="id89">is_auto_managed() auto_managed()</a></li>
<li><a class="reference internal" href="#has-metadata-set-metadata" id="id90">has_metadata() set_metadata()</a></li>
<li><a class="reference internal" href="#set-tracker-login" id="id91">set_tracker_login()</a></li>
<li><a class="reference internal" href="#trackers-replace-trackers" id="id92">trackers() replace_trackers()</a></li>
<li><a class="reference internal" href="#add-url-seed-remove-url-seed-url-seeds" id="id93">add_url_seed() remove_url_seed() url_seeds()</a></li>
<li><a class="reference internal" href="#queue-position-queue-position-up-queue-position-down-queue-position-top-queue-position-bottom" id="id94">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="id95">use_interface()</a></li>
<li><a class="reference internal" href="#info-hash" id="id96">info_hash()</a></li>
<li><a class="reference internal" href="#id6" id="id97">set_max_uploads() set_max_connections() max_connections()</a></li>
<li><a class="reference internal" href="#save-resume-data" id="id98">save_resume_data()</a></li>
<li><a class="reference internal" href="#id7" id="id99">status()</a></li>
<li><a class="reference internal" href="#get-download-queue" id="id100">get_download_queue()</a></li>
<li><a class="reference internal" href="#get-peer-info" id="id101">get_peer_info()</a></li>
<li><a class="reference internal" href="#get-torrent-info" id="id102">get_torrent_info()</a></li>
<li><a class="reference internal" href="#is-valid" id="id103">is_valid()</a></li>
<li><a class="reference internal" href="#torrent-handle" id="id70">torrent_handle</a><ul>
<li><a class="reference internal" href="#piece-priority-prioritize-pieces-piece-priorities" id="id71">piece_priority() prioritize_pieces() piece_priorities()</a></li>
<li><a class="reference internal" href="#file-priority-prioritize-files-file-priorities" id="id72">file_priority() prioritize_files() file_priorities()</a></li>
<li><a class="reference internal" href="#file-progress" id="id73">file_progress()</a></li>
<li><a class="reference internal" href="#save-path" id="id74">save_path()</a></li>
<li><a class="reference internal" href="#move-storage" id="id75">move_storage()</a></li>
<li><a class="reference internal" href="#rename-file" id="id76">rename_file()</a></li>
<li><a class="reference internal" href="#get-storage-impl" id="id77">get_storage_impl()</a></li>
<li><a class="reference internal" href="#force-reannounce" id="id78">force_reannounce()</a></li>
<li><a class="reference internal" href="#scrape-tracker" id="id79">scrape_tracker()</a></li>
<li><a class="reference internal" href="#connect-peer" id="id80">connect_peer()</a></li>
<li><a class="reference internal" href="#name" id="id81">name()</a></li>
<li><a class="reference internal" href="#set-ratio" id="id82">set_ratio()</a></li>
<li><a class="reference internal" href="#set-upload-limit-set-download-limit-upload-limit-download-limit" id="id83">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="id84">set_sequential_download() is_sequential_download()</a></li>
<li><a class="reference internal" href="#set-peer-upload-limit-set-peer-download-limit" id="id85">set_peer_upload_limit() set_peer_download_limit()</a></li>
<li><a class="reference internal" href="#id5" id="id86">pause() resume() is_paused()</a></li>
<li><a class="reference internal" href="#force-recheck" id="id87">force_recheck()</a></li>
<li><a class="reference internal" href="#clear-error" id="id88">clear_error()</a></li>
<li><a class="reference internal" href="#resolve-countries" id="id89">resolve_countries()</a></li>
<li><a class="reference internal" href="#is-seed" id="id90">is_seed()</a></li>
<li><a class="reference internal" href="#is-auto-managed-auto-managed" id="id91">is_auto_managed() auto_managed()</a></li>
<li><a class="reference internal" href="#has-metadata-set-metadata" id="id92">has_metadata() set_metadata()</a></li>
<li><a class="reference internal" href="#set-tracker-login" id="id93">set_tracker_login()</a></li>
<li><a class="reference internal" href="#trackers-replace-trackers-add-tracker" id="id94">trackers() replace_trackers() add_tracker()</a></li>
<li><a class="reference internal" href="#add-url-seed-remove-url-seed-url-seeds" id="id95">add_url_seed() remove_url_seed() url_seeds()</a></li>
<li><a class="reference internal" href="#queue-position-queue-position-up-queue-position-down-queue-position-top-queue-position-bottom" id="id96">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="id97">use_interface()</a></li>
<li><a class="reference internal" href="#info-hash" id="id98">info_hash()</a></li>
<li><a class="reference internal" href="#id6" id="id99">set_max_uploads() set_max_connections() max_connections()</a></li>
<li><a class="reference internal" href="#save-resume-data" id="id100">save_resume_data()</a></li>
<li><a class="reference internal" href="#id7" id="id101">status()</a></li>
<li><a class="reference internal" href="#get-download-queue" id="id102">get_download_queue()</a></li>
<li><a class="reference internal" href="#get-peer-info" id="id103">get_peer_info()</a></li>
<li><a class="reference internal" href="#get-torrent-info" id="id104">get_torrent_info()</a></li>
<li><a class="reference internal" href="#is-valid" id="id105">is_valid()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#torrent-status" id="id104">torrent_status</a></li>
<li><a class="reference internal" href="#peer-info" id="id105">peer_info</a></li>
<li><a class="reference internal" href="#session-settings" id="id106">session_settings</a></li>
<li><a class="reference internal" href="#pe-settings" id="id107">pe_settings</a></li>
<li><a class="reference internal" href="#proxy-settings" id="id108">proxy_settings</a></li>
<li><a class="reference internal" href="#ip-filter" id="id109">ip_filter</a><ul>
<li><a class="reference internal" href="#id10" id="id110">ip_filter()</a></li>
<li><a class="reference internal" href="#add-rule" id="id111">add_rule()</a></li>
<li><a class="reference internal" href="#access" id="id112">access()</a></li>
<li><a class="reference internal" href="#export-filter" id="id113">export_filter()</a></li>
<li><a class="reference internal" href="#torrent-status" id="id106">torrent_status</a></li>
<li><a class="reference internal" href="#peer-info" id="id107">peer_info</a></li>
<li><a class="reference internal" href="#session-settings" id="id108">session_settings</a></li>
<li><a class="reference internal" href="#pe-settings" id="id109">pe_settings</a></li>
<li><a class="reference internal" href="#proxy-settings" id="id110">proxy_settings</a></li>
<li><a class="reference internal" href="#ip-filter" id="id111">ip_filter</a><ul>
<li><a class="reference internal" href="#id10" id="id112">ip_filter()</a></li>
<li><a class="reference internal" href="#add-rule" id="id113">add_rule()</a></li>
<li><a class="reference internal" href="#access" id="id114">access()</a></li>
<li><a class="reference internal" href="#export-filter" id="id115">export_filter()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#big-number" id="id114">big_number</a></li>
<li><a class="reference internal" href="#bitfield" id="id115">bitfield</a></li>
<li><a class="reference internal" href="#hasher" id="id116">hasher</a></li>
<li><a class="reference internal" href="#fingerprint" id="id117">fingerprint</a></li>
<li><a class="reference internal" href="#upnp-and-nat-pmp" id="id118">UPnP and NAT-PMP</a><ul>
<li><a class="reference internal" href="#add-mapping" id="id119">add_mapping</a></li>
<li><a class="reference internal" href="#delete-mapping" id="id120">delete_mapping</a></li>
<li><a class="reference internal" href="#router-model" id="id121">router_model()</a></li>
<li><a class="reference internal" href="#big-number" id="id116">big_number</a></li>
<li><a class="reference internal" href="#bitfield" id="id117">bitfield</a></li>
<li><a class="reference internal" href="#hasher" id="id118">hasher</a></li>
<li><a class="reference internal" href="#fingerprint" id="id119">fingerprint</a></li>
<li><a class="reference internal" href="#upnp-and-nat-pmp" id="id120">UPnP and NAT-PMP</a><ul>
<li><a class="reference internal" href="#add-mapping" id="id121">add_mapping</a></li>
<li><a class="reference internal" href="#delete-mapping" id="id122">delete_mapping</a></li>
<li><a class="reference internal" href="#router-model" id="id123">router_model()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#free-functions" id="id122">free functions</a><ul>
<li><a class="reference internal" href="#identify-client" id="id123">identify_client()</a></li>
<li><a class="reference internal" href="#client-fingerprint" id="id124">client_fingerprint()</a></li>
<li><a class="reference internal" href="#bdecode-bencode" id="id125">bdecode() bencode()</a></li>
<li><a class="reference internal" href="#add-magnet-uri" id="id126">add_magnet_uri()</a></li>
<li><a class="reference internal" href="#make-magnet-uri" id="id127">make_magnet_uri()</a></li>
<li><a class="reference internal" href="#free-functions" id="id124">free functions</a><ul>
<li><a class="reference internal" href="#identify-client" id="id125">identify_client()</a></li>
<li><a class="reference internal" href="#client-fingerprint" id="id126">client_fingerprint()</a></li>
<li><a class="reference internal" href="#bdecode-bencode" id="id127">bdecode() bencode()</a></li>
<li><a class="reference internal" href="#add-magnet-uri" id="id128">add_magnet_uri()</a></li>
<li><a class="reference internal" href="#make-magnet-uri" id="id129">make_magnet_uri()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#alerts" id="id128">alerts</a><ul>
<li><a class="reference internal" href="#external-ip-alert" id="id129">external_ip_alert</a></li>
<li><a class="reference internal" href="#listen-failed-alert" id="id130">listen_failed_alert</a></li>
<li><a class="reference internal" href="#portmap-error-alert" id="id131">portmap_error_alert</a></li>
<li><a class="reference internal" href="#portmap-alert" id="id132">portmap_alert</a></li>
<li><a class="reference internal" href="#portmap-log-alert" id="id133">portmap_log_alert</a></li>
<li><a class="reference internal" href="#file-error-alert" id="id134">file_error_alert</a></li>
<li><a class="reference internal" href="#tracker-announce-alert" id="id135">tracker_announce_alert</a></li>
<li><a class="reference internal" href="#tracker-error-alert" id="id136">tracker_error_alert</a></li>
<li><a class="reference internal" href="#tracker-reply-alert" id="id137">tracker_reply_alert</a></li>
<li><a class="reference internal" href="#dht-reply-alert" id="id138">dht_reply_alert</a></li>
<li><a class="reference internal" href="#tracker-warning-alert" id="id139">tracker_warning_alert</a></li>
<li><a class="reference internal" href="#scrape-reply-alert" id="id140">scrape_reply_alert</a></li>
<li><a class="reference internal" href="#scrape-failed-alert" id="id141">scrape_failed_alert</a></li>
<li><a class="reference internal" href="#url-seed-alert" id="id142">url_seed_alert</a></li>
<li><a class="reference internal" href="#hash-failed-alert" id="id143">hash_failed_alert</a></li>
<li><a class="reference internal" href="#peer-ban-alert" id="id144">peer_ban_alert</a></li>
<li><a class="reference internal" href="#peer-error-alert" id="id145">peer_error_alert</a></li>
<li><a class="reference internal" href="#invalid-request-alert" id="id146">invalid_request_alert</a></li>
<li><a class="reference internal" href="#torrent-finished-alert" id="id147">torrent_finished_alert</a></li>
<li><a class="reference internal" href="#performance-alert" id="id148">performance_alert</a></li>
<li><a class="reference internal" href="#metadata-failed-alert" id="id149">metadata_failed_alert</a></li>
<li><a class="reference internal" href="#metadata-received-alert" id="id150">metadata_received_alert</a></li>
<li><a class="reference internal" href="#fastresume-rejected-alert" id="id151">fastresume_rejected_alert</a></li>
<li><a class="reference internal" href="#peer-blocked-alert" id="id152">peer_blocked_alert</a></li>
<li><a class="reference internal" href="#storage-moved-alert" id="id153">storage_moved_alert</a></li>
<li><a class="reference internal" href="#torrent-paused-alert" id="id154">torrent_paused_alert</a></li>
<li><a class="reference internal" href="#torrent-resumed-alert" id="id155">torrent_resumed_alert</a></li>
<li><a class="reference internal" href="#save-resume-data-alert" id="id156">save_resume_data_alert</a></li>
<li><a class="reference internal" href="#save-resume-data-failed-alert" id="id157">save_resume_data_failed_alert</a></li>
<li><a class="reference internal" href="#dht-announce-alert" id="id158">dht_announce_alert</a></li>
<li><a class="reference internal" href="#dht-get-peers-alert" id="id159">dht_get_peers_alert</a></li>
<li><a class="reference internal" href="#dispatcher" id="id160">dispatcher</a></li>
<li><a class="reference internal" href="#alerts" id="id130">alerts</a><ul>
<li><a class="reference internal" href="#external-ip-alert" id="id131">external_ip_alert</a></li>
<li><a class="reference internal" href="#listen-failed-alert" id="id132">listen_failed_alert</a></li>
<li><a class="reference internal" href="#portmap-error-alert" id="id133">portmap_error_alert</a></li>
<li><a class="reference internal" href="#portmap-alert" id="id134">portmap_alert</a></li>
<li><a class="reference internal" href="#portmap-log-alert" id="id135">portmap_log_alert</a></li>
<li><a class="reference internal" href="#file-error-alert" id="id136">file_error_alert</a></li>
<li><a class="reference internal" href="#tracker-announce-alert" id="id137">tracker_announce_alert</a></li>
<li><a class="reference internal" href="#tracker-error-alert" id="id138">tracker_error_alert</a></li>
<li><a class="reference internal" href="#tracker-reply-alert" id="id139">tracker_reply_alert</a></li>
<li><a class="reference internal" href="#dht-reply-alert" id="id140">dht_reply_alert</a></li>
<li><a class="reference internal" href="#tracker-warning-alert" id="id141">tracker_warning_alert</a></li>
<li><a class="reference internal" href="#scrape-reply-alert" id="id142">scrape_reply_alert</a></li>
<li><a class="reference internal" href="#scrape-failed-alert" id="id143">scrape_failed_alert</a></li>
<li><a class="reference internal" href="#url-seed-alert" id="id144">url_seed_alert</a></li>
<li><a class="reference internal" href="#hash-failed-alert" id="id145">hash_failed_alert</a></li>
<li><a class="reference internal" href="#peer-ban-alert" id="id146">peer_ban_alert</a></li>
<li><a class="reference internal" href="#peer-error-alert" id="id147">peer_error_alert</a></li>
<li><a class="reference internal" href="#invalid-request-alert" id="id148">invalid_request_alert</a></li>
<li><a class="reference internal" href="#torrent-finished-alert" id="id149">torrent_finished_alert</a></li>
<li><a class="reference internal" href="#performance-alert" id="id150">performance_alert</a></li>
<li><a class="reference internal" href="#metadata-failed-alert" id="id151">metadata_failed_alert</a></li>
<li><a class="reference internal" href="#metadata-received-alert" id="id152">metadata_received_alert</a></li>
<li><a class="reference internal" href="#fastresume-rejected-alert" id="id153">fastresume_rejected_alert</a></li>
<li><a class="reference internal" href="#peer-blocked-alert" id="id154">peer_blocked_alert</a></li>
<li><a class="reference internal" href="#storage-moved-alert" id="id155">storage_moved_alert</a></li>
<li><a class="reference internal" href="#torrent-paused-alert" id="id156">torrent_paused_alert</a></li>
<li><a class="reference internal" href="#torrent-resumed-alert" id="id157">torrent_resumed_alert</a></li>
<li><a class="reference internal" href="#save-resume-data-alert" id="id158">save_resume_data_alert</a></li>
<li><a class="reference internal" href="#save-resume-data-failed-alert" id="id159">save_resume_data_failed_alert</a></li>
<li><a class="reference internal" href="#dht-announce-alert" id="id160">dht_announce_alert</a></li>
<li><a class="reference internal" href="#dht-get-peers-alert" id="id161">dht_get_peers_alert</a></li>
<li><a class="reference internal" href="#dispatcher" id="id162">dispatcher</a></li>
</ul>
</li>
<li><a class="reference internal" href="#exceptions" id="id161">exceptions</a><ul>
<li><a class="reference internal" href="#invalid-handle" id="id162">invalid_handle</a></li>
<li><a class="reference internal" href="#duplicate-torrent" id="id163">duplicate_torrent</a></li>
<li><a class="reference internal" href="#invalid-encoding" id="id164">invalid_encoding</a></li>
<li><a class="reference internal" href="#type-error" id="id165">type_error</a></li>
<li><a class="reference internal" href="#invalid-torrent-file" id="id166">invalid_torrent_file</a></li>
<li><a class="reference internal" href="#exceptions" id="id163">exceptions</a><ul>
<li><a class="reference internal" href="#invalid-handle" id="id164">invalid_handle</a></li>
<li><a class="reference internal" href="#duplicate-torrent" id="id165">duplicate_torrent</a></li>
<li><a class="reference internal" href="#invalid-encoding" id="id166">invalid_encoding</a></li>
<li><a class="reference internal" href="#type-error" id="id167">type_error</a></li>
<li><a class="reference internal" href="#invalid-torrent-file" id="id168">invalid_torrent_file</a></li>
</ul>
</li>
<li><a class="reference internal" href="#storage-interface" id="id167">storage_interface</a><ul>
<li><a class="reference internal" href="#initialize" id="id168">initialize()</a></li>
<li><a class="reference internal" href="#read" id="id169">read()</a></li>
<li><a class="reference internal" href="#write" id="id170">write()</a></li>
<li><a class="reference internal" href="#id12" id="id171">move_storage()</a></li>
<li><a class="reference internal" href="#verify-resume-data" id="id172">verify_resume_data()</a></li>
<li><a class="reference internal" href="#write-resume-data" id="id173">write_resume_data()</a></li>
<li><a class="reference internal" href="#move-slot" id="id174">move_slot()</a></li>
<li><a class="reference internal" href="#swap-slots" id="id175">swap_slots()</a></li>
<li><a class="reference internal" href="#swap-slots3" id="id176">swap_slots3()</a></li>
<li><a class="reference internal" href="#hash-for-slot" id="id177">hash_for_slot()</a></li>
<li><a class="reference internal" href="#rename-file" id="id178">rename_file()</a></li>
<li><a class="reference internal" href="#release-files" id="id179">release_files()</a></li>
<li><a class="reference internal" href="#delete-files" id="id180">delete_files()</a></li>
<li><a class="reference internal" href="#storage-interface" id="id169">storage_interface</a><ul>
<li><a class="reference internal" href="#initialize" id="id170">initialize()</a></li>
<li><a class="reference internal" href="#read" id="id171">read()</a></li>
<li><a class="reference internal" href="#write" id="id172">write()</a></li>
<li><a class="reference internal" href="#id12" id="id173">move_storage()</a></li>
<li><a class="reference internal" href="#verify-resume-data" id="id174">verify_resume_data()</a></li>
<li><a class="reference internal" href="#write-resume-data" id="id175">write_resume_data()</a></li>
<li><a class="reference internal" href="#move-slot" id="id176">move_slot()</a></li>
<li><a class="reference internal" href="#swap-slots" id="id177">swap_slots()</a></li>
<li><a class="reference internal" href="#swap-slots3" id="id178">swap_slots3()</a></li>
<li><a class="reference internal" href="#hash-for-slot" id="id179">hash_for_slot()</a></li>
<li><a class="reference internal" href="#id13" id="id180">rename_file()</a></li>
<li><a class="reference internal" href="#release-files" id="id181">release_files()</a></li>
<li><a class="reference internal" href="#delete-files" id="id182">delete_files()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#magnet-links" id="id181">magnet links</a></li>
<li><a class="reference internal" href="#queuing" id="id182">queuing</a><ul>
<li><a class="reference internal" href="#downloading" id="id183">downloading</a></li>
<li><a class="reference internal" href="#seeding" id="id184">seeding</a></li>
<li><a class="reference internal" href="#magnet-links" id="id183">magnet links</a></li>
<li><a class="reference internal" href="#queuing" id="id184">queuing</a><ul>
<li><a class="reference internal" href="#downloading" id="id185">downloading</a></li>
<li><a class="reference internal" href="#seeding" id="id186">seeding</a></li>
</ul>
</li>
<li><a class="reference internal" href="#fast-resume" id="id185">fast resume</a><ul>
<li><a class="reference internal" href="#file-format" id="id186">file format</a></li>
<li><a class="reference internal" href="#fast-resume" id="id187">fast resume</a><ul>
<li><a class="reference internal" href="#file-format" id="id188">file format</a></li>
</ul>
</li>
<li><a class="reference internal" href="#threads" id="id187">threads</a></li>
<li><a class="reference internal" href="#storage-allocation" id="id188">storage allocation</a><ul>
<li><a class="reference internal" href="#sparse-allocation" id="id189">sparse allocation</a></li>
<li><a class="reference internal" href="#full-allocation" id="id190">full allocation</a></li>
<li><a class="reference internal" href="#compact-allocation" id="id191">compact allocation</a></li>
<li><a class="reference internal" href="#threads" id="id189">threads</a></li>
<li><a class="reference internal" href="#storage-allocation" id="id190">storage allocation</a><ul>
<li><a class="reference internal" href="#sparse-allocation" id="id191">sparse allocation</a></li>
<li><a class="reference internal" href="#full-allocation" id="id192">full allocation</a></li>
<li><a class="reference internal" href="#compact-allocation" id="id193">compact allocation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#extensions" id="id192">extensions</a><ul>
<li><a class="reference internal" href="#metadata-from-peers" id="id193">metadata from peers</a></li>
<li><a class="reference internal" href="#http-seeding" id="id194">HTTP seeding</a></li>
<li><a class="reference internal" href="#extensions" id="id194">extensions</a><ul>
<li><a class="reference internal" href="#metadata-from-peers" id="id195">metadata from peers</a></li>
<li><a class="reference internal" href="#http-seeding" id="id196">HTTP seeding</a></li>
</ul>
</li>
<li><a class="reference internal" href="#filename-checks" id="id195">filename checks</a></li>
<li><a class="reference internal" href="#acknowledgments" id="id196">acknowledgments</a></li>
<li><a class="reference internal" href="#filename-checks" id="id197">filename checks</a></li>
<li><a class="reference internal" href="#acknowledgments" id="id198">acknowledgments</a></li>
</ul>
</div>
<div class="section" id="overview">
@ -1595,9 +1596,37 @@ struct announce_entry
{
announce_entry(std::string const&amp; 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;
};
</pre>
<p><tt class="docutils literal"><span class="pre">fail_limit</span></tt> is the max number of failures to announce to this tracker in
a row, before this tracker is not used anymore.</p>
<p><tt class="docutils literal"><span class="pre">fails</span></tt> is the number of times in a row we have failed to announce to this
tracker.</p>
<p><tt class="docutils literal"><span class="pre">source</span></tt> is a bitmask specifying which sources we got this tracker from.</p>
<p><tt class="docutils literal"><span class="pre">verified</span></tt> is set to true the first time we receive a valid response
from this tracker.</p>
<p><tt class="docutils literal"><span class="pre">updating</span></tt> is true while we're waiting for a response from the tracker.</p>
<p><tt class="docutils literal"><span class="pre">start_sent</span></tt> 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.</p>
<p><tt class="docutils literal"><span class="pre">complete_sent</span></tt> is set to true when we send a event=completed.</p>
</div>
<div class="section" id="total-size-piece-length-piece-size-num-pieces">
<h2>total_size() piece_length() piece_size() num_pieces()</h2>
@ -1722,6 +1751,7 @@ struct torrent_handle
std::vector&lt;announce_entry&gt; const&amp; trackers() const;
void replace_trackers(std::vector&lt;announce_entry&gt; const&amp;);
void add_tracker(announc_entry const&amp; url);
void add_url_seed(std::string const&amp; url);
void remove_url_seed(std::string const&amp; url);
@ -1777,6 +1807,7 @@ struct torrent_handle
boost::filesystem::path save_path() const;
void move_storage(boost::filesystem::path const&amp; 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.</p>
Once the operation completes, the <tt class="docutils literal"><span class="pre">storage_moved_alert</span></tt> is generated, with the new
path as the message.</p>
</div>
<div class="section" id="rename-file">
<h2>rename_file()</h2>
<blockquote>
<pre class="literal-block">
void rename_file(int index, boost::filesystem::path) const;
</pre>
</blockquote>
<p>Renames the file with the given index asynchronously. The rename operation is complete
when either a <tt class="docutils literal"><span class="pre">file_renamed_alert</span></tt> or <tt class="docutils literal"><span class="pre">file_rename_failed_alert</span></tt> is posted.</p>
</div>
<div class="section" id="get-storage-impl">
<h2>get_storage_impl()</h2>
<blockquote>
@ -2127,12 +2168,13 @@ void set_tracker_login(std::string const&amp; username
<p><tt class="docutils literal"><span class="pre">set_tracker_login()</span></tt> 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.</p>
</div>
<div class="section" id="trackers-replace-trackers">
<h2>trackers() replace_trackers()</h2>
<div class="section" id="trackers-replace-trackers-add-tracker">
<h2>trackers() replace_trackers() add_tracker()</h2>
<blockquote>
<pre class="literal-block">
std::vector&lt;announce_entry&gt; const&amp; trackers() const;
void replace_trackers(std::vector&lt;announce_entry&gt; const&amp;) const;
void add_tracker(announc_entry const&amp; url);
</pre>
</blockquote>
<p><tt class="docutils literal"><span class="pre">trackers()</span></tt> will return the list of trackers for this torrent. The
@ -2143,6 +2185,9 @@ trackers for this torrent, you can use <tt class="docutils literal"><span class=
a list of the same form as the one returned from <tt class="docutils literal"><span class="pre">trackers()</span></tt> and will
replace it. If you want an immediate effect, you have to call
<a class="reference internal" href="#force-reannounce">force_reannounce()</a>.</p>
<p><tt class="docutils literal"><span class="pre">add_tracker()</span></tt> 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.</p>
</div>
<div class="section" id="add-url-seed-remove-url-seed-url-seeds">
<h2>add_url_seed() remove_url_seed() url_seeds()</h2>
@ -3078,6 +3123,8 @@ struct session_settings
int auto_manage_startup;
bool rate_limit_ip_overhead;
bool announce_to_all_trackers;
};
</pre>
<p><tt class="docutils literal"><span class="pre">user_agent</span></tt> 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.</p>
<p>If <tt class="docutils literal"><span class="pre">rate_limit_ip_overhead</span></tt> is set to true, the estimated TCP/IP overhead is
drained from the rate limiters, to avoid exceeding the limits with the total traffic</p>
<p><tt class="docutils literal"><span class="pre">announce_to_all_trackers</span></tt> 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.</p>
</div>
<div class="section" id="pe-settings">
<h1>pe_settings</h1>
@ -4658,7 +4712,7 @@ struct partial_hash
that is stored in the given slot.</p>
<p>The function should return the hash of the piece stored in the slot.</p>
</div>
<div class="section" id="rename-file">
<div class="section" id="id13">
<h2>rename_file()</h2>
<blockquote>
<pre class="literal-block">