- session()
- ~session()
- abort()
- add_torrent() -
- remove_torrent() find_torrent() get_torrents() -
- set_upload_rate_limit() set_download_rate_limit() upload_rate_limit() download_rate_limit() -
- set_max_uploads() set_max_connections() -
- num_uploads() num_connections() -
- set_max_half_open_connections() max_half_open_connections() -
- set_ip_filter() -
- status() -
- is_listening() listen_port() listen_on() -
- pop_alert() set_severity_level() -
- add_extension() -
- set_settings() set_pe_settings() -
- set_peer_proxy() set_web_seed_proxy() set_tracker_proxy() set_dht_proxy() -
- peer_proxy() web_seed_proxy() tracker_proxy() dht_proxy() -
- start_dht() stop_dht() set_dht_settings() dht_state() -
- add_dht_node() add_dht_router() +
- remove_torrent() +
- find_torrent() get_torrents() +
- set_upload_rate_limit() set_download_rate_limit() upload_rate_limit() download_rate_limit() +
- set_max_uploads() set_max_connections() +
- num_uploads() num_connections() +
- set_max_half_open_connections() max_half_open_connections() +
- set_ip_filter() +
- status() +
- is_listening() listen_port() listen_on() +
- pop_alert() set_severity_level() +
- add_extension() +
- set_settings() set_pe_settings() +
- set_peer_proxy() set_web_seed_proxy() set_tracker_proxy() set_dht_proxy() +
- peer_proxy() web_seed_proxy() tracker_proxy() dht_proxy() +
- start_dht() stop_dht() set_dht_settings() dht_state() +
- add_dht_node() add_dht_router()
-
-
- integer() string() list() dict() type() -
- operator[] -
- find_key() +
- entry -
- torrent_info
-
-
- torrent_info() -
- set_comment() set_piece_size() set_creator() set_hash() add_tracker() add_file() -
- create_torrent() -
- remap_files() -
- begin_files() end_files() rbegin_files() rend_files() -
- num_files() file_at() -
- map_block() -
- map_file() -
- url_seeds() add_url_seed() -
- print() -
- trackers() -
- total_size() piece_length() piece_size() num_pieces() -
- hash_for_piece() info_hash() -
- name() comment() creation_date() creator() -
- priv() set_priv() -
- nodes() -
- add_node() +
- torrent_info
-
+
- torrent_info() +
- set_comment() set_piece_size() set_creator() set_hash() add_tracker() add_file() +
- create_torrent() +
- remap_files() +
- begin_files() end_files() rbegin_files() rend_files() +
- num_files() file_at() +
- map_block() +
- map_file() +
- url_seeds() add_url_seed() +
- print() +
- trackers() +
- total_size() piece_length() piece_size() num_pieces() +
- hash_for_piece() info_hash() +
- name() comment() creation_date() creator() +
- priv() set_priv() +
- nodes() +
- add_node()
- - torrent_handle
-
-
- piece_priority() prioritize_pieces() piece_priorities() prioritize_files() -
- file_progress() -
- save_path() -
- move_storage() -
- force_reannounce() -
- connect_peer() -
- name() -
- set_ratio() -
- set_upload_limit() set_download_limit() upload_limit() download_limit() -
- set_sequenced_download_threshold() -
- set_peer_upload_limit() set_peer_download_limit() -
- pause() resume() is_paused() -
- resolve_countries() -
- is_seed() -
- has_metadata() -
- set_tracker_login() -
- trackers() replace_trackers() -
- add_url_seed() remove_url_seed() url_seeds() -
- use_interface() -
- info_hash() -
- set_max_uploads() set_max_connections() -
- write_resume_data() -
- status() -
- get_download_queue() -
- get_peer_info() -
- get_torrent_info() -
- is_valid() +
- torrent_handle
-
+
- piece_priority() prioritize_pieces() piece_priorities() prioritize_files() +
- file_progress() +
- save_path() +
- move_storage() +
- force_reannounce() +
- scrape_tracker() +
- connect_peer() +
- name() +
- set_ratio() +
- set_upload_limit() set_download_limit() upload_limit() download_limit() +
- set_sequenced_download_threshold() +
- set_peer_upload_limit() set_peer_download_limit() +
- pause() resume() is_paused() +
- resolve_countries() +
- is_seed() +
- has_metadata() +
- set_tracker_login() +
- trackers() replace_trackers() +
- add_url_seed() remove_url_seed() url_seeds() +
- use_interface() +
- info_hash() +
- set_max_uploads() set_max_connections() +
- write_resume_data() +
- status() +
- get_download_queue() +
- get_peer_info() +
- get_torrent_info() +
- is_valid()
- - torrent_status -
- peer_info -
- session_settings -
- pe_settings -
- proxy_settings -
- ip_filter
-
-
- ip_filter() -
- add_rule() -
- access() -
- export_filter() +
- torrent_status +
- peer_info +
- session_settings +
- pe_settings +
- proxy_settings +
- ip_filter -
- big_number -
- hasher -
- fingerprint -
- free functions
-
-
- identify_client() -
- client_fingerprint() -
- bdecode() bencode() -
- supports_sparse_files() +
- big_number +
- hasher +
- fingerprint +
- free functions -
- alerts
-
-
- listen_failed_alert -
- portmap_error_alert -
- portmap_alert -
- file_error_alert -
- tracker_announce_alert -
- tracker_alert -
- tracker_reply_alert -
- tracker_warning_alert -
- url_seed_alert -
- hash_failed_alert -
- peer_ban_alert -
- peer_error_alert -
- invalid_request_alert -
- torrent_finished_alert -
- metadata_failed_alert -
- metadata_received_alert -
- fastresume_rejected_alert -
- peer_blocked_alert -
- storage_moved_alert -
- torrent_paused_alert -
- dispatcher +
- alerts
-
+
- listen_failed_alert +
- portmap_error_alert +
- portmap_alert +
- file_error_alert +
- tracker_announce_alert +
- tracker_alert +
- tracker_reply_alert +
- tracker_warning_alert +
- scrape_reply_alert +
- scrape_failed_alert +
- url_seed_alert +
- hash_failed_alert +
- peer_ban_alert +
- peer_error_alert +
- invalid_request_alert +
- torrent_finished_alert +
- metadata_failed_alert +
- metadata_received_alert +
- fastresume_rejected_alert +
- peer_blocked_alert +
- storage_moved_alert +
- torrent_paused_alert +
- dispatcher
- - exceptions
-
-
- invalid_handle -
- duplicate_torrent -
- invalid_encoding -
- type_error -
- invalid_torrent_file +
- exceptions -
- storage_interface
-
-
- initialize() -
- read() -
- write() -
- move_storage() -
- verify_resume_data() -
- write_resume_data() -
- move_slot() -
- swap_slots() -
- swap_slots3() -
- hash_for_slot() -
- release_files() -
- delete_files() +
- storage_interface -
- fast resume
-
-
- file format +
- fast resume -
- threads -
- storage allocation
-
-
- sparse allocation -
- full allocation -
- compact allocation +
- threads +
- storage allocation -
- extensions
-
-
- metadata from peers -
- HTTP seeding +
- extensions -
- filename checks -
- acknowledgments +
- filename checks +
- acknowledgments
@@ -201,7 +205,7 @@ the session, it contaconstruct a session
-parse .torrent-files and add them to the session (see bdecode() bencode())
+parse .torrent-files and add them to the session (see bdecode() bencode() and add_torrent())
main loop (see session)
@@ -213,7 +217,7 @@ the session, it conta
save resume data for all torrent_handles (optional, see -`write_resume_data()`_)
+write_resume_data())destruct session object
@@ -221,7 +225,7 @@ the session, it conta
Each class and function is described in this manual.
-primitive network types
+network primitives
There are a few typedefs in the libtorrent namespace which pulls in network types from the asio namespace. These are:
@@ -239,6 +243,7 @@ udp::endpoint
Which are the endpoint types used in libtorrent. An endpoint is an address with an associated port.
+For documentation on these types, please refer to the asio documentation.
session
@@ -274,7 +279,13 @@ class session: public boost::noncopyable session_proxy abort(); - void remove_torrent(torrent_handle const& h); + enum options_t + { + none = 0, + delete_files = 1 + }; + + void remove_torrent(torrent_handle const& h, int options = none); torrent_handle find_torrent(sha_hash const& ih); std::vector<torrent_handle> get_torrents() const; @@ -456,16 +467,27 @@ have metadata. See torrent_handle tracker_url can be 0.-+remove_torrent() find_torrent() get_torrents()
+remove_torrent()
++
++void remove_torrent(torrent_handle const& h, int options = none); +
+remove_torrent() will close all peer connections associated with the torrent and tell +the tracker that we've stopped participating in the swarm. The optional second argument +options can be used to delete all the files downloaded by this torrent. To do this, pass +in the value session::delete_files. The removal of the torrent is asyncronous, there is +no guarantee that adding the same torrent immediately after it was removed will not throw +a duplicate_torrent exception.
+++find_torrent() get_torrents()
--void remove_torrent(torrent_handle const& h); torrent_handle find_torrent(sha_hash const& ih); std::vector<torrent_handle> get_torrents() const;
remove_torrent() will close all peer connections associated with the torrent and tell -the tracker that we've stopped participating in the swarm.
find_torrent() looks for a torrent with the given info-hash. In case there is such a torrent in the session, a torrent_handle to that torrent is returned. In case the torrent cannot be found, an invalid torrent_handle is returned.
@@ -1401,6 +1423,8 @@ struct torrent_handle entry write_resume_data() const; void force_reannounce() const; + void force_reannounce(boost::posix_time::time_duration) const; + void scrape_tracker() const; void connect_peer(asio::ip::tcp::endpoint const& adr, int source = 0) const; void set_tracker_login(std::string const& username @@ -1559,11 +1583,26 @@ thread, this operation is also asynchronous. Once the operation completes, thevoid force_reannounce() const; +void force_reannounce(boost::posix_time::time_duration) const;
force_reannounce() will force this torrent to do another tracker request, to receive new -peers. If the torrent is invalid, queued or in checking mode, this functions will throw -invalid_handle.
+peers. The second overload of force_reannounce that takes a time_duration as +argument will schedule a reannounce in that amount of time from now. ++scrape_tracker()
++
++void scrape_tracker() const; +
+scrape_tracker() will send a scrape request to the tracker. A scrape request queries the +tracker for statistics such as total number of incomplete peers, complete peers, number of +downloads etc.
+This request will specifically update the num_complete and num_incomplete fields in +the torrent_status struct once it completes. When it completes, it will generate a +scrape_reply_alert. If it fails, it will generate a scrape_failed_alert.
connect_peer()
@@ -1936,6 +1975,7 @@ struct torrent_status queued_for_checking, checking_files, connecting_to_tracker, + downloading_metadata, downloading, finished, seeding, @@ -2012,6 +2052,10 @@ currently checking existing files.The torrent has sent a request to the tracker and is currently waiting for a response +downloading_metadata +The torrent is trying to download metadata from peers. +This assumes the metadata_transfer extension is in use. +downloading The torrent is being downloaded. This is the state most torrents will be in most of the time. The progress @@ -2362,6 +2406,7 @@ struct session_settings bool lazy_bitfields; int inactivity_timeout; bool use_dht_as_fallback; + bool free_torrent_hashes; }; user_agent this is the client identification to the tracker. @@ -2462,6 +2507,13 @@ Default is 10 minutes
(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. +free_torrent_hashes determines whether or not the torrent's piece hashes +are kept in memory after the torrent becomes a seed or not. If it is set to +true the hashes are freed once the torrent is a seed (they're not +needed anymore since the torrent won't download anything more). If it's set +to false they are not freed. If they are freed, the torrent_info returned +by get_torrent_info() will return an object that may be incomplete, that +cannot be passed back to add_torrent() for instance.
pe_settings
@@ -3083,6 +3135,41 @@ struct tracker_warning_alert: torrent_alert++scrape_reply_alert
++struct scrape_reply_alert: torrent_alert +{ + scrape_reply_alert(torrent_handle const& h + , int incomplete_ + , int complete_ + , std::string const& msg); + + int incomplete; + int complete; + + virtual std::auto_ptr<alert> clone() const; +}; ++This alert is generated when a scrape request succeeds. incomplete +and complete is the data returned in the scrape response. These numbers +may be -1 if the reponse was malformed.
+++scrape_failed_alert
++struct scrape_failed_alert: torrent_alert +{ + scrape_failed_alert(torrent_handle const& h + , std::string const& msg); + + virtual std::auto_ptr<alert> clone() const; +}; ++If a scrape request fails, this alert is generated. This might be due +to the tracker timing out, refusing connection or returning an http response +code indicating an error.
+url_seed_alert
This alert is generated when a HTTP seed name lookup fails. This alert is generated as severity level warning.
@@ -3363,7 +3450,8 @@ struct invalid_handle: std::exceptionduplicate_torrent
This is thrown by add_torrent() if the torrent already has been added to -the session.
+the session. Since remove_torrent() is asynchronous, this exception may +be thrown if the torrent is removed and then immediately added again.struct duplicate_torrent: std::exception { @@ -3484,7 +3572,7 @@ not, set error to a dThe default storage may compare file sizes and time stamps of the files.
--write_resume_data()
+write_resume_data( )
void write_resume_data(entry& rd) const = 0; @@ -3986,12 +4074,6 @@ scripts.
Project is hosted by sourceforge.