separated session from session_impl and made a real pimpl-class of it. Introduced the possibility to destruct the sessions async.
This commit is contained in:
Arvid Norberg
236
docs/manual.html
236
docs/manual.html
@@ -29,137 +29,138 @@
|
||||
<li><a class="reference" href="#session" id="id17" name="id17">session</a><ul>
|
||||
<li><a class="reference" href="#id1" id="id18" name="id18">session()</a></li>
|
||||
<li><a class="reference" href="#id2" id="id19" name="id19">~session()</a></li>
|
||||
<li><a class="reference" href="#add-torrent" id="id20" name="id20">add_torrent()</a></li>
|
||||
<li><a class="reference" href="#remove-torrent" id="id21" name="id21">remove_torrent()</a></li>
|
||||
<li><a class="reference" href="#disable-extensions-enable-extension" id="id22" name="id22">disable_extensions() enable_extension()</a></li>
|
||||
<li><a class="reference" href="#set-upload-rate-limit-set-download-rate-limit" id="id23" name="id23">set_upload_rate_limit() set_download_rate_limit()</a></li>
|
||||
<li><a class="reference" href="#set-max-uploads-set-max-connections" id="id24" name="id24">set_max_uploads() set_max_connections()</a></li>
|
||||
<li><a class="reference" href="#set-max-half-open-connections" id="id25" name="id25">set_max_half_open_connections()</a></li>
|
||||
<li><a class="reference" href="#set-ip-filter" id="id26" name="id26">set_ip_filter()</a></li>
|
||||
<li><a class="reference" href="#status" id="id27" name="id27">status()</a></li>
|
||||
<li><a class="reference" href="#is-listening-listen-port-listen-on" id="id28" name="id28">is_listening() listen_port() listen_on()</a></li>
|
||||
<li><a class="reference" href="#pop-alert-set-severity-level" id="id29" name="id29">pop_alert() set_severity_level()</a></li>
|
||||
<li><a class="reference" href="#start-dht-stop-dht-set-dht-settings-dht-state" id="id30" name="id30">start_dht() stop_dht() set_dht_settings() dht_state()</a></li>
|
||||
<li><a class="reference" href="#add-dht-node-add-dht-router" id="id31" name="id31">add_dht_node() add_dht_router()</a></li>
|
||||
<li><a class="reference" href="#abort" id="id20" name="id20">abort()</a></li>
|
||||
<li><a class="reference" href="#add-torrent" id="id21" name="id21">add_torrent()</a></li>
|
||||
<li><a class="reference" href="#remove-torrent" id="id22" name="id22">remove_torrent()</a></li>
|
||||
<li><a class="reference" href="#disable-extensions-enable-extension" id="id23" name="id23">disable_extensions() enable_extension()</a></li>
|
||||
<li><a class="reference" href="#set-upload-rate-limit-set-download-rate-limit" id="id24" name="id24">set_upload_rate_limit() set_download_rate_limit()</a></li>
|
||||
<li><a class="reference" href="#set-max-uploads-set-max-connections" id="id25" name="id25">set_max_uploads() set_max_connections()</a></li>
|
||||
<li><a class="reference" href="#set-max-half-open-connections" id="id26" name="id26">set_max_half_open_connections()</a></li>
|
||||
<li><a class="reference" href="#set-ip-filter" id="id27" name="id27">set_ip_filter()</a></li>
|
||||
<li><a class="reference" href="#status" id="id28" name="id28">status()</a></li>
|
||||
<li><a class="reference" href="#is-listening-listen-port-listen-on" id="id29" name="id29">is_listening() listen_port() listen_on()</a></li>
|
||||
<li><a class="reference" href="#pop-alert-set-severity-level" id="id30" name="id30">pop_alert() set_severity_level()</a></li>
|
||||
<li><a class="reference" href="#start-dht-stop-dht-set-dht-settings-dht-state" id="id31" name="id31">start_dht() stop_dht() set_dht_settings() dht_state()</a></li>
|
||||
<li><a class="reference" href="#add-dht-node-add-dht-router" id="id32" name="id32">add_dht_node() add_dht_router()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#entry" id="id32" name="id32">entry</a><ul>
|
||||
<li><a class="reference" href="#integer-string-list-dict-type" id="id33" name="id33">integer() string() list() dict() type()</a></li>
|
||||
<li><a class="reference" href="#operator" id="id34" name="id34">operator[]</a></li>
|
||||
<li><a class="reference" href="#find-key" id="id35" name="id35">find_key()</a></li>
|
||||
<li><a class="reference" href="#entry" id="id33" name="id33">entry</a><ul>
|
||||
<li><a class="reference" href="#integer-string-list-dict-type" id="id34" name="id34">integer() string() list() dict() type()</a></li>
|
||||
<li><a class="reference" href="#operator" id="id35" name="id35">operator[]</a></li>
|
||||
<li><a class="reference" href="#find-key" id="id36" name="id36">find_key()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#torrent-info" id="id36" name="id36">torrent_info</a><ul>
|
||||
<li><a class="reference" href="#id3" id="id37" name="id37">torrent_info()</a></li>
|
||||
<li><a class="reference" href="#set-comment-set-piece-size-set-creator-set-hash-add-tracker-add-file" id="id38" name="id38">set_comment() set_piece_size() set_creator() set_hash() add_tracker() add_file()</a></li>
|
||||
<li><a class="reference" href="#create-torrent" id="id39" name="id39">create_torrent()</a></li>
|
||||
<li><a class="reference" href="#begin-files-end-files-rbegin-files-rend-files" id="id40" name="id40">begin_files() end_files() rbegin_files() rend_files()</a></li>
|
||||
<li><a class="reference" href="#num-files-file-at" id="id41" name="id41">num_files() file_at()</a></li>
|
||||
<li><a class="reference" href="#map-block" id="id42" name="id42">map_block()</a></li>
|
||||
<li><a class="reference" href="#map-file" id="id43" name="id43">map_file()</a></li>
|
||||
<li><a class="reference" href="#url-seeds" id="id44" name="id44">url_seeds()</a></li>
|
||||
<li><a class="reference" href="#print" id="id45" name="id45">print()</a></li>
|
||||
<li><a class="reference" href="#trackers" id="id46" name="id46">trackers()</a></li>
|
||||
<li><a class="reference" href="#total-size-piece-length-piece-size-num-pieces" id="id47" name="id47">total_size() piece_length() piece_size() num_pieces()</a></li>
|
||||
<li><a class="reference" href="#hash-for-piece-info-hash" id="id48" name="id48">hash_for_piece() info_hash()</a></li>
|
||||
<li><a class="reference" href="#name-comment-creation-date-creator" id="id49" name="id49">name() comment() creation_date() creator()</a></li>
|
||||
<li><a class="reference" href="#priv-set-priv" id="id50" name="id50">priv() set_priv()</a></li>
|
||||
<li><a class="reference" href="#nodes" id="id51" name="id51">nodes()</a></li>
|
||||
<li><a class="reference" href="#add-node" id="id52" name="id52">add_node()</a></li>
|
||||
<li><a class="reference" href="#torrent-info" id="id37" name="id37">torrent_info</a><ul>
|
||||
<li><a class="reference" href="#id3" id="id38" name="id38">torrent_info()</a></li>
|
||||
<li><a class="reference" href="#set-comment-set-piece-size-set-creator-set-hash-add-tracker-add-file" id="id39" name="id39">set_comment() set_piece_size() set_creator() set_hash() add_tracker() add_file()</a></li>
|
||||
<li><a class="reference" href="#create-torrent" id="id40" name="id40">create_torrent()</a></li>
|
||||
<li><a class="reference" href="#begin-files-end-files-rbegin-files-rend-files" id="id41" name="id41">begin_files() end_files() rbegin_files() rend_files()</a></li>
|
||||
<li><a class="reference" href="#num-files-file-at" id="id42" name="id42">num_files() file_at()</a></li>
|
||||
<li><a class="reference" href="#map-block" id="id43" name="id43">map_block()</a></li>
|
||||
<li><a class="reference" href="#map-file" id="id44" name="id44">map_file()</a></li>
|
||||
<li><a class="reference" href="#url-seeds" id="id45" name="id45">url_seeds()</a></li>
|
||||
<li><a class="reference" href="#print" id="id46" name="id46">print()</a></li>
|
||||
<li><a class="reference" href="#trackers" id="id47" name="id47">trackers()</a></li>
|
||||
<li><a class="reference" href="#total-size-piece-length-piece-size-num-pieces" id="id48" name="id48">total_size() piece_length() piece_size() num_pieces()</a></li>
|
||||
<li><a class="reference" href="#hash-for-piece-info-hash" id="id49" name="id49">hash_for_piece() info_hash()</a></li>
|
||||
<li><a class="reference" href="#name-comment-creation-date-creator" id="id50" name="id50">name() comment() creation_date() creator()</a></li>
|
||||
<li><a class="reference" href="#priv-set-priv" id="id51" name="id51">priv() set_priv()</a></li>
|
||||
<li><a class="reference" href="#nodes" id="id52" name="id52">nodes()</a></li>
|
||||
<li><a class="reference" href="#add-node" id="id53" name="id53">add_node()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#torrent-handle" id="id53" name="id53">torrent_handle</a><ul>
|
||||
<li><a class="reference" href="#file-progress" id="id54" name="id54">file_progress()</a></li>
|
||||
<li><a class="reference" href="#save-path" id="id55" name="id55">save_path()</a></li>
|
||||
<li><a class="reference" href="#move-storage" id="id56" name="id56">move_storage()</a></li>
|
||||
<li><a class="reference" href="#force-reannounce" id="id57" name="id57">force_reannounce()</a></li>
|
||||
<li><a class="reference" href="#connect-peer" id="id58" name="id58">connect_peer()</a></li>
|
||||
<li><a class="reference" href="#set-ratio" id="id59" name="id59">set_ratio()</a></li>
|
||||
<li><a class="reference" href="#set-upload-limit-set-download-limit" id="id60" name="id60">set_upload_limit() set_download_limit()</a></li>
|
||||
<li><a class="reference" href="#set-sequenced-download-threshold" id="id61" name="id61">set_sequenced_download_threshold()</a></li>
|
||||
<li><a class="reference" href="#set-peer-upload-limit-set-peer-download-limit" id="id62" name="id62">set_peer_upload_limit() set_peer_download_limit()</a></li>
|
||||
<li><a class="reference" href="#pause-resume-is-paused" id="id63" name="id63">pause() resume() is_paused()</a></li>
|
||||
<li><a class="reference" href="#is-seed" id="id64" name="id64">is_seed()</a></li>
|
||||
<li><a class="reference" href="#has-metadata" id="id65" name="id65">has_metadata()</a></li>
|
||||
<li><a class="reference" href="#set-tracker-login" id="id66" name="id66">set_tracker_login()</a></li>
|
||||
<li><a class="reference" href="#trackers-replace-trackers" id="id67" name="id67">trackers() replace_trackers()</a></li>
|
||||
<li><a class="reference" href="#add-url-seed" id="id68" name="id68">add_url_seed()</a></li>
|
||||
<li><a class="reference" href="#use-interface" id="id69" name="id69">use_interface()</a></li>
|
||||
<li><a class="reference" href="#info-hash" id="id70" name="id70">info_hash()</a></li>
|
||||
<li><a class="reference" href="#id5" id="id71" name="id71">set_max_uploads() set_max_connections()</a></li>
|
||||
<li><a class="reference" href="#write-resume-data" id="id72" name="id72">write_resume_data()</a></li>
|
||||
<li><a class="reference" href="#metadata" id="id73" name="id73">metadata()</a></li>
|
||||
<li><a class="reference" href="#id6" id="id74" name="id74">status()</a></li>
|
||||
<li><a class="reference" href="#get-download-queue" id="id75" name="id75">get_download_queue()</a></li>
|
||||
<li><a class="reference" href="#get-peer-info" id="id76" name="id76">get_peer_info()</a></li>
|
||||
<li><a class="reference" href="#get-torrent-info" id="id77" name="id77">get_torrent_info()</a></li>
|
||||
<li><a class="reference" href="#is-valid" id="id78" name="id78">is_valid()</a></li>
|
||||
<li><a class="reference" href="#torrent-handle" id="id54" name="id54">torrent_handle</a><ul>
|
||||
<li><a class="reference" href="#file-progress" id="id55" name="id55">file_progress()</a></li>
|
||||
<li><a class="reference" href="#save-path" id="id56" name="id56">save_path()</a></li>
|
||||
<li><a class="reference" href="#move-storage" id="id57" name="id57">move_storage()</a></li>
|
||||
<li><a class="reference" href="#force-reannounce" id="id58" name="id58">force_reannounce()</a></li>
|
||||
<li><a class="reference" href="#connect-peer" id="id59" name="id59">connect_peer()</a></li>
|
||||
<li><a class="reference" href="#set-ratio" id="id60" name="id60">set_ratio()</a></li>
|
||||
<li><a class="reference" href="#set-upload-limit-set-download-limit" id="id61" name="id61">set_upload_limit() set_download_limit()</a></li>
|
||||
<li><a class="reference" href="#set-sequenced-download-threshold" id="id62" name="id62">set_sequenced_download_threshold()</a></li>
|
||||
<li><a class="reference" href="#set-peer-upload-limit-set-peer-download-limit" id="id63" name="id63">set_peer_upload_limit() set_peer_download_limit()</a></li>
|
||||
<li><a class="reference" href="#pause-resume-is-paused" id="id64" name="id64">pause() resume() is_paused()</a></li>
|
||||
<li><a class="reference" href="#is-seed" id="id65" name="id65">is_seed()</a></li>
|
||||
<li><a class="reference" href="#has-metadata" id="id66" name="id66">has_metadata()</a></li>
|
||||
<li><a class="reference" href="#set-tracker-login" id="id67" name="id67">set_tracker_login()</a></li>
|
||||
<li><a class="reference" href="#trackers-replace-trackers" id="id68" name="id68">trackers() replace_trackers()</a></li>
|
||||
<li><a class="reference" href="#add-url-seed" id="id69" name="id69">add_url_seed()</a></li>
|
||||
<li><a class="reference" href="#use-interface" id="id70" name="id70">use_interface()</a></li>
|
||||
<li><a class="reference" href="#info-hash" id="id71" name="id71">info_hash()</a></li>
|
||||
<li><a class="reference" href="#id5" id="id72" name="id72">set_max_uploads() set_max_connections()</a></li>
|
||||
<li><a class="reference" href="#write-resume-data" id="id73" name="id73">write_resume_data()</a></li>
|
||||
<li><a class="reference" href="#metadata" id="id74" name="id74">metadata()</a></li>
|
||||
<li><a class="reference" href="#id6" id="id75" name="id75">status()</a></li>
|
||||
<li><a class="reference" href="#get-download-queue" id="id76" name="id76">get_download_queue()</a></li>
|
||||
<li><a class="reference" href="#get-peer-info" id="id77" name="id77">get_peer_info()</a></li>
|
||||
<li><a class="reference" href="#get-torrent-info" id="id78" name="id78">get_torrent_info()</a></li>
|
||||
<li><a class="reference" href="#is-valid" id="id79" name="id79">is_valid()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#torrent-status" id="id79" name="id79">torrent_status</a></li>
|
||||
<li><a class="reference" href="#peer-info" id="id80" name="id80">peer_info</a></li>
|
||||
<li><a class="reference" href="#session-settings" id="id81" name="id81">session_settings</a></li>
|
||||
<li><a class="reference" href="#ip-filter" id="id82" name="id82">ip_filter</a><ul>
|
||||
<li><a class="reference" href="#id8" id="id83" name="id83">ip_filter()</a></li>
|
||||
<li><a class="reference" href="#add-rule" id="id84" name="id84">add_rule()</a></li>
|
||||
<li><a class="reference" href="#access" id="id85" name="id85">access()</a></li>
|
||||
<li><a class="reference" href="#export-filter" id="id86" name="id86">export_filter()</a></li>
|
||||
<li><a class="reference" href="#torrent-status" id="id80" name="id80">torrent_status</a></li>
|
||||
<li><a class="reference" href="#peer-info" id="id81" name="id81">peer_info</a></li>
|
||||
<li><a class="reference" href="#session-settings" id="id82" name="id82">session_settings</a></li>
|
||||
<li><a class="reference" href="#ip-filter" id="id83" name="id83">ip_filter</a><ul>
|
||||
<li><a class="reference" href="#id8" id="id84" name="id84">ip_filter()</a></li>
|
||||
<li><a class="reference" href="#add-rule" id="id85" name="id85">add_rule()</a></li>
|
||||
<li><a class="reference" href="#access" id="id86" name="id86">access()</a></li>
|
||||
<li><a class="reference" href="#export-filter" id="id87" name="id87">export_filter()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#big-number" id="id87" name="id87">big_number</a></li>
|
||||
<li><a class="reference" href="#hasher" id="id88" name="id88">hasher</a></li>
|
||||
<li><a class="reference" href="#fingerprint" id="id89" name="id89">fingerprint</a></li>
|
||||
<li><a class="reference" href="#free-functions" id="id90" name="id90">free functions</a><ul>
|
||||
<li><a class="reference" href="#identify-client" id="id91" name="id91">identify_client()</a></li>
|
||||
<li><a class="reference" href="#client-fingerprint" id="id92" name="id92">client_fingerprint()</a></li>
|
||||
<li><a class="reference" href="#bdecode-bencode" id="id93" name="id93">bdecode() bencode()</a></li>
|
||||
<li><a class="reference" href="#big-number" id="id88" name="id88">big_number</a></li>
|
||||
<li><a class="reference" href="#hasher" id="id89" name="id89">hasher</a></li>
|
||||
<li><a class="reference" href="#fingerprint" id="id90" name="id90">fingerprint</a></li>
|
||||
<li><a class="reference" href="#free-functions" id="id91" name="id91">free functions</a><ul>
|
||||
<li><a class="reference" href="#identify-client" id="id92" name="id92">identify_client()</a></li>
|
||||
<li><a class="reference" href="#client-fingerprint" id="id93" name="id93">client_fingerprint()</a></li>
|
||||
<li><a class="reference" href="#bdecode-bencode" id="id94" name="id94">bdecode() bencode()</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#alerts" id="id94" name="id94">alerts</a><ul>
|
||||
<li><a class="reference" href="#listen-failed-alert" id="id95" name="id95">listen_failed_alert</a></li>
|
||||
<li><a class="reference" href="#file-error-alert" id="id96" name="id96">file_error_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-announce-alert" id="id97" name="id97">tracker_announce_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-alert" id="id98" name="id98">tracker_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-reply-alert" id="id99" name="id99">tracker_reply_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-warning-alert" id="id100" name="id100">tracker_warning_alert</a></li>
|
||||
<li><a class="reference" href="#url-seed-alert" id="id101" name="id101">url_seed_alert</a></li>
|
||||
<li><a class="reference" href="#hash-failed-alert" id="id102" name="id102">hash_failed_alert</a></li>
|
||||
<li><a class="reference" href="#peer-ban-alert" id="id103" name="id103">peer_ban_alert</a></li>
|
||||
<li><a class="reference" href="#peer-error-alert" id="id104" name="id104">peer_error_alert</a></li>
|
||||
<li><a class="reference" href="#invalid-request-alert" id="id105" name="id105">invalid_request_alert</a></li>
|
||||
<li><a class="reference" href="#torrent-finished-alert" id="id106" name="id106">torrent_finished_alert</a></li>
|
||||
<li><a class="reference" href="#metadata-failed-alert" id="id107" name="id107">metadata_failed_alert</a></li>
|
||||
<li><a class="reference" href="#metadata-received-alert" id="id108" name="id108">metadata_received_alert</a></li>
|
||||
<li><a class="reference" href="#fastresume-rejected-alert" id="id109" name="id109">fastresume_rejected_alert</a></li>
|
||||
<li><a class="reference" href="#dispatcher" id="id110" name="id110">dispatcher</a></li>
|
||||
<li><a class="reference" href="#alerts" id="id95" name="id95">alerts</a><ul>
|
||||
<li><a class="reference" href="#listen-failed-alert" id="id96" name="id96">listen_failed_alert</a></li>
|
||||
<li><a class="reference" href="#file-error-alert" id="id97" name="id97">file_error_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-announce-alert" id="id98" name="id98">tracker_announce_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-alert" id="id99" name="id99">tracker_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-reply-alert" id="id100" name="id100">tracker_reply_alert</a></li>
|
||||
<li><a class="reference" href="#tracker-warning-alert" id="id101" name="id101">tracker_warning_alert</a></li>
|
||||
<li><a class="reference" href="#url-seed-alert" id="id102" name="id102">url_seed_alert</a></li>
|
||||
<li><a class="reference" href="#hash-failed-alert" id="id103" name="id103">hash_failed_alert</a></li>
|
||||
<li><a class="reference" href="#peer-ban-alert" id="id104" name="id104">peer_ban_alert</a></li>
|
||||
<li><a class="reference" href="#peer-error-alert" id="id105" name="id105">peer_error_alert</a></li>
|
||||
<li><a class="reference" href="#invalid-request-alert" id="id106" name="id106">invalid_request_alert</a></li>
|
||||
<li><a class="reference" href="#torrent-finished-alert" id="id107" name="id107">torrent_finished_alert</a></li>
|
||||
<li><a class="reference" href="#metadata-failed-alert" id="id108" name="id108">metadata_failed_alert</a></li>
|
||||
<li><a class="reference" href="#metadata-received-alert" id="id109" name="id109">metadata_received_alert</a></li>
|
||||
<li><a class="reference" href="#fastresume-rejected-alert" id="id110" name="id110">fastresume_rejected_alert</a></li>
|
||||
<li><a class="reference" href="#dispatcher" id="id111" name="id111">dispatcher</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#exceptions" id="id111" name="id111">exceptions</a><ul>
|
||||
<li><a class="reference" href="#invalid-handle" id="id112" name="id112">invalid_handle</a></li>
|
||||
<li><a class="reference" href="#duplicate-torrent" id="id113" name="id113">duplicate_torrent</a></li>
|
||||
<li><a class="reference" href="#invalid-encoding" id="id114" name="id114">invalid_encoding</a></li>
|
||||
<li><a class="reference" href="#type-error" id="id115" name="id115">type_error</a></li>
|
||||
<li><a class="reference" href="#invalid-torrent-file" id="id116" name="id116">invalid_torrent_file</a></li>
|
||||
<li><a class="reference" href="#exceptions" id="id112" name="id112">exceptions</a><ul>
|
||||
<li><a class="reference" href="#invalid-handle" id="id113" name="id113">invalid_handle</a></li>
|
||||
<li><a class="reference" href="#duplicate-torrent" id="id114" name="id114">duplicate_torrent</a></li>
|
||||
<li><a class="reference" href="#invalid-encoding" id="id115" name="id115">invalid_encoding</a></li>
|
||||
<li><a class="reference" href="#type-error" id="id116" name="id116">type_error</a></li>
|
||||
<li><a class="reference" href="#invalid-torrent-file" id="id117" name="id117">invalid_torrent_file</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#fast-resume" id="id117" name="id117">fast resume</a><ul>
|
||||
<li><a class="reference" href="#file-format" id="id118" name="id118">file format</a></li>
|
||||
<li><a class="reference" href="#fast-resume" id="id118" name="id118">fast resume</a><ul>
|
||||
<li><a class="reference" href="#file-format" id="id119" name="id119">file format</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#threads" id="id119" name="id119">threads</a></li>
|
||||
<li><a class="reference" href="#storage-allocation" id="id120" name="id120">storage allocation</a><ul>
|
||||
<li><a class="reference" href="#full-allocation" id="id121" name="id121">full allocation</a></li>
|
||||
<li><a class="reference" href="#compact-allocation" id="id122" name="id122">compact allocation</a></li>
|
||||
<li><a class="reference" href="#threads" id="id120" name="id120">threads</a></li>
|
||||
<li><a class="reference" href="#storage-allocation" id="id121" name="id121">storage allocation</a><ul>
|
||||
<li><a class="reference" href="#full-allocation" id="id122" name="id122">full allocation</a></li>
|
||||
<li><a class="reference" href="#compact-allocation" id="id123" name="id123">compact allocation</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#extensions" id="id123" name="id123">extensions</a><ul>
|
||||
<li><a class="reference" href="#chat-messages" id="id124" name="id124">chat messages</a></li>
|
||||
<li><a class="reference" href="#metadata-from-peers" id="id125" name="id125">metadata from peers</a></li>
|
||||
<li><a class="reference" href="#http-seeding" id="id126" name="id126">HTTP seeding</a></li>
|
||||
<li><a class="reference" href="#extensions" id="id124" name="id124">extensions</a><ul>
|
||||
<li><a class="reference" href="#chat-messages" id="id125" name="id125">chat messages</a></li>
|
||||
<li><a class="reference" href="#metadata-from-peers" id="id126" name="id126">metadata from peers</a></li>
|
||||
<li><a class="reference" href="#http-seeding" id="id127" name="id127">HTTP seeding</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference" href="#filename-checks" id="id127" name="id127">filename checks</a></li>
|
||||
<li><a class="reference" href="#acknowledgments" id="id128" name="id128">acknowledgments</a></li>
|
||||
<li><a class="reference" href="#filename-checks" id="id128" name="id128">filename checks</a></li>
|
||||
<li><a class="reference" href="#acknowledgments" id="id129" name="id129">acknowledgments</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="overview">
|
||||
@@ -240,6 +241,8 @@ class session: public boost::noncopyable
|
||||
, bool compact_mode = true
|
||||
, int block_size = 16 * 1024);
|
||||
|
||||
session_proxy abort();
|
||||
|
||||
void remove_torrent(torrent_handle const& h);
|
||||
|
||||
void disable_extensions();
|
||||
@@ -309,6 +312,21 @@ returns. So, it's advised that any kind of interface (such as windows) are close
|
||||
destructing the session object. Because it can take a few second for it to finish. The
|
||||
timeout can be set with <tt class="docutils literal"><span class="pre">set_settings()</span></tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="abort">
|
||||
<h2><a name="abort">abort()</a></h2>
|
||||
<p>In case you want to destruct the session asynchrounously, you can request a session
|
||||
destruction proxy. If you don't do this, the destructor of the session object will
|
||||
block while the trackers are contacted. If you keep one <tt class="docutils literal"><span class="pre">session_proxy</span></tt> to the
|
||||
session when destructing it, the destructor will not block, but start to close down
|
||||
the session, the destructor of the proxy will then synchronize the threads. So, the
|
||||
destruction of the session is performed from the <tt class="docutils literal"><span class="pre">session</span></tt> destructor call until the
|
||||
<tt class="docutils literal"><span class="pre">session_proxy</span></tt> destructor call. The <tt class="docutils literal"><span class="pre">session_proxy</span></tt> does not have any operations
|
||||
on it (since the session is being closed down, no operations are allowed on it). The
|
||||
only valid operation is calling the destructor:</p>
|
||||
<pre class="literal-block">
|
||||
class session_proxy { ~session_proxy() };
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="add-torrent">
|
||||
<h2><a name="add-torrent">add_torrent()</a></h2>
|
||||
<blockquote>
|
||||
|
||||
@@ -85,6 +85,8 @@ The ``session`` class has the following synopsis::
|
||||
, bool compact_mode = true
|
||||
, int block_size = 16 * 1024);
|
||||
|
||||
session_proxy abort();
|
||||
|
||||
void remove_torrent(torrent_handle const& h);
|
||||
|
||||
void disable_extensions();
|
||||
@@ -156,6 +158,21 @@ returns. So, it's advised that any kind of interface (such as windows) are close
|
||||
destructing the session object. Because it can take a few second for it to finish. The
|
||||
timeout can be set with ``set_settings()``.
|
||||
|
||||
abort()
|
||||
-------
|
||||
|
||||
In case you want to destruct the session asynchrounously, you can request a session
|
||||
destruction proxy. If you don't do this, the destructor of the session object will
|
||||
block while the trackers are contacted. If you keep one ``session_proxy`` to the
|
||||
session when destructing it, the destructor will not block, but start to close down
|
||||
the session, the destructor of the proxy will then synchronize the threads. So, the
|
||||
destruction of the session is performed from the ``session`` destructor call until the
|
||||
``session_proxy`` destructor call. The ``session_proxy`` does not have any operations
|
||||
on it (since the session is being closed down, no operations are allowed on it). The
|
||||
only valid operation is calling the destructor::
|
||||
|
||||
class session_proxy { ~session_proxy() };
|
||||
|
||||
|
||||
add_torrent()
|
||||
-------------
|
||||
|
||||
Reference in New Issue
Block a user