used by storage to return errors\n also includes which underlying file the\n error happened on
\n\n struct storage_error\n {\n explicit operator bool () const;\n- file_index_t file () const;\n void file (file_index_t f);\n+ file_index_t file () const;\n \n error_code ec;\n operation_t operation;\n };\n \n [report issue]explicitly converts to true if this object represents an error, and\n false if it does not.
\n [report issue]\n-file_index_t file () const;\n void file (file_index_t f);\n+file_index_t file () const;\n\n
set and query the index (in the torrent) of the file this error\n occurred on. This may also have special values defined in\n torrent_status.
\n [report issue]\n struct session_params\n {\n session_params (settings_pack&& sp);\n session_params (settings_pack const& sp);\n session_params ();\n- session_params (settings_pack&& sp\n- , std::vector<std::shared_ptr<plugin>> exts);\n session_params (settings_pack const& sp\n , std::vector<std::shared_ptr<plugin>> exts);\n+ session_params (settings_pack&& sp\n+ , std::vector<std::shared_ptr<plugin>> exts);\n \n settings_pack settings;\n std::vector<std::shared_ptr<plugin>> extensions;\n dht::dht_state dht_state;\n dht::dht_storage_constructor_type dht_storage_constructor;\n disk_io_constructor_type disk_io_constructor;\n std::map<std::string, std::string> ext_state;\n@@ -2149,18 +2149,18 @@\n This constructor can be used to start with the default plugins\n (ut_metadata, ut_pex and smart_ban). Pass a settings_pack to set the\n initial settings when the session starts.
\n [report issue]\n-session_params (settings_pack&& sp\n- , std::vector<std::shared_ptr<plugin>> exts);\n session_params (settings_pack const& sp\n , std::vector<std::shared_ptr<plugin>> exts);\n+session_params (settings_pack&& sp\n+ , std::vector<std::shared_ptr<plugin>> exts);\n\n
This constructor helps to configure the set of initial plugins\n to be added to the session before it's started.
\n [report issue]\n struct session_proxy\n {\n- session_proxy& operator= (session_proxy const&) &;\n- ~session_proxy ();\n- session_proxy ();\n session_proxy (session_proxy&&) noexcept;\n- session_proxy& operator= (session_proxy&&) & noexcept;\n+ ~session_proxy ();\n+ session_proxy& operator= (session_proxy const&) &;\n session_proxy (session_proxy const&);\n+ session_proxy& operator= (session_proxy&&) & noexcept;\n+ session_proxy ();\n };\n \n-\n+\n \n-[report issue]\n-session_proxy& operator= (session_proxy const&) &;\n-~session_proxy ();\n-session_proxy ();\n session_proxy (session_proxy&&) noexcept;\n-session_proxy& operator= (session_proxy&&) & noexcept;\n+~session_proxy ();\n+session_proxy& operator= (session_proxy const&) &;\n session_proxy (session_proxy const&);\n+session_proxy& operator= (session_proxy&&) & noexcept;\n+session_proxy ();\n\n
default constructor, does not refer to any session\n implementation object.
\n [report issue]\n@@ -2277,17 +2277,17 @@\n add_default_plugins do not have an affect on constructors that\n take a session_params object. It already contains the plugins to use.\n [report issue]
\n session (session_params const& params, io_context& ios);\n-session (session_params const& params, io_context& ios, session_flags_t);\n session (session_params&& params, io_context& ios, session_flags_t);\n session (session_params&& params, io_context& ios);\n+session (session_params const& params, io_context& ios, session_flags_t);\n\n
Overload of the constructor that takes an external io_context to run\n the session object on. This is primarily useful for tests that may want\n to run multiple sessions on a single io_context, or low resource\n systems where additional threads are expensive and sharing an\n io_context with other events is fine.
\n\n struct session_handle\n {\n bool is_valid () const;\n session_params session_state (save_state_flags_t flags = save_state_flags_t::all()) const;\n+ void refresh_torrent_status (std::vector<torrent_status>* ret\n+ , status_flags_t flags = {}) const;\n std::vector<torrent_status> get_torrent_status (\n std::function<bool(torrent_status const&)> const& pred\n , status_flags_t flags = {}) const;\n- void refresh_torrent_status (std::vector<torrent_status>* ret\n- , status_flags_t flags = {}) const;\n void post_torrent_updates (status_flags_t flags = status_flags_t::all());\n void post_session_stats ();\n void post_dht_stats ();\n void set_dht_state (dht::dht_state&& st);\n void set_dht_state (dht::dht_state const& st);\n torrent_handle find_torrent (sha1_hash const& info_hash) const;\n std::vector<torrent_handle> get_torrents () const;\n torrent_handle add_torrent (add_torrent_params&& params);\n- void async_add_torrent (add_torrent_params&& params);\n- torrent_handle add_torrent (add_torrent_params&& params, error_code& ec);\n torrent_handle add_torrent (add_torrent_params const& params);\n torrent_handle add_torrent (add_torrent_params const& params, error_code& ec);\n void async_add_torrent (add_torrent_params const& params);\n- void pause ();\n- bool is_paused () const;\n+ void async_add_torrent (add_torrent_params&& params);\n+ torrent_handle add_torrent (add_torrent_params&& params, error_code& ec);\n void resume ();\n+ bool is_paused () const;\n+ void pause ();\n bool is_dht_running () const;\n void set_dht_storage (dht::dht_storage_constructor_type sc);\n void add_dht_node (std::pair<std::string, int> const& node);\n void dht_get_item (sha1_hash const& target);\n void dht_get_item (std::array<char, 32> key\n , std::string salt = std::string());\n sha1_hash dht_put_item (entry data);\n void dht_put_item (std::array<char, 32> key\n , std::function<void(entry&, std::array<char, 64>&\n , std::int64_t&, std::string const&)> cb\n , std::string salt = std::string());\n- void dht_get_peers (sha1_hash const& info_hash);\n void dht_announce (sha1_hash const& info_hash, int port = 0, dht::announce_flags_t flags = {});\n+ void dht_get_peers (sha1_hash const& info_hash);\n void dht_live_nodes (sha1_hash const& nid);\n void dht_sample_infohashes (udp::endpoint const& ep, sha1_hash const& target);\n void dht_direct_request (udp::endpoint const& ep, entry const& e, client_data_t userdata = {});\n void add_extension (std::function<std::shared_ptr<torrent_plugin>(\n torrent_handle const&, client_data_t)> ext);\n void add_extension (std::shared_ptr<plugin> ext);\n ip_filter get_ip_filter () const;\n void set_ip_filter (ip_filter f);\n void set_port_filter (port_filter const& f);\n- bool is_listening () const;\n unsigned short listen_port () const;\n unsigned short ssl_listen_port () const;\n+ bool is_listening () const;\n void set_peer_class_filter (ip_filter const& f);\n ip_filter get_peer_class_filter () const;\n peer_class_type_filter get_peer_class_type_filter () const;\n void set_peer_class_type_filter (peer_class_type_filter const& f);\n peer_class_t create_peer_class (char const* name);\n void delete_peer_class (peer_class_t cid);\n peer_class_info get_peer_class (peer_class_t cid) const;\n void set_peer_class (peer_class_t cid, peer_class_info const& pci);\n void remove_torrent (const torrent_handle&, remove_flags_t = {});\n- void apply_settings (settings_pack const&);\n- settings_pack get_settings () const;\n void apply_settings (settings_pack&&);\n- void set_alert_notify (std::function<void()> const& fun);\n+ settings_pack get_settings () const;\n+ void apply_settings (settings_pack const&);\n alert* wait_for_alert (time_duration max_wait);\n+ void set_alert_notify (std::function<void()> const& fun);\n void pop_alerts (std::vector<alert*>* alerts);\n std::vector<port_mapping_t> add_port_mapping (portmap_protocol t, int external_port, int local_port);\n void delete_port_mapping (port_mapping_t handle);\n void reopen_network_sockets (reopen_network_flags_t options = reopen_map_ports);\n std::shared_ptr<aux::session_impl> native_handle () const;\n \n static constexpr save_state_flags_t save_settings = 0_bit;\n@@ -2444,24 +2444,24 @@\n returns the current session state. This can be passed to\n write_session_params() to save the state to disk and restored using\n read_session_params() when constructing a new session. The kind of\n state that's included is all settings, the DHT routing table, possibly\n plugin-specific state.\n the flags parameter can be used to only save certain parts of the\n session state
\n-\n-[report issue]\n+void refresh_torrent_status (std::vector<torrent_status>* ret\n+ , status_flags_t flags = {}) const;\n std::vector<torrent_status> get_torrent_status (\n std::function<bool(torrent_status const&)> const& pred\n , status_flags_t flags = {}) const;\n-void refresh_torrent_status (std::vector<torrent_status>* ret\n- , status_flags_t flags = {}) const;\n \n Note
\nthese calls are potentially expensive and won't scale well with\n lots of torrents. If you're concerned about performance, consider\n using post_torrent_updates() instead.
\n\n void set_dht_state (dht::dht_state&& st);\n void set_dht_state (dht::dht_state const& st);\n\n
set the DHT state for the session. This will be taken into account the\n next time the DHT is started, as if it had been passed in via the\n session_params on startup.
\n-\n-[report issue]\n torrent_handle find_torrent (sha1_hash const& info_hash) const;\n std::vector<torrent_handle> get_torrents () const;\n\n
find_torrent() looks for a torrent with the given info-hash. In\n case there is such a torrent in the session, a torrent_handle to that\n torrent is returned. In case the torrent cannot be found, an invalid\n torrent_handle is returned.
\nSee torrent_handle::is_valid() to know if the torrent was found or\n not.
\nget_torrents() returns a vector of torrent_handles to all the\n torrents currently in the session.
\n-\n-[report issue]\n torrent_handle add_torrent (add_torrent_params&& params);\n-void async_add_torrent (add_torrent_params&& params);\n-torrent_handle add_torrent (add_torrent_params&& params, error_code& ec);\n torrent_handle add_torrent (add_torrent_params const& params);\n torrent_handle add_torrent (add_torrent_params const& params, error_code& ec);\n void async_add_torrent (add_torrent_params const& params);\n+void async_add_torrent (add_torrent_params&& params);\n+torrent_handle add_torrent (add_torrent_params&& params, error_code& ec);\n\n
You add torrents through the add_torrent() function where you give an\n object with all the parameters. The add_torrent() overloads will block\n until the torrent has been added (or failed to be added) and returns\n an error code and a torrent_handle. In order to add torrents more\n efficiently, consider using async_add_torrent() which returns\n immediately, without waiting for the torrent to add. Notification of\n@@ -2585,23 +2585,23 @@\n want to control are torrent_flags::paused and\n torrent_flags::auto_managed. In order to add a magnet link that will\n just download the metadata, but no payload, set the\n torrent_flags::upload_mode flag.
\nSpecial consideration has to be taken when adding hybrid torrents\n (i.e. torrents that are BitTorrent v2 torrents that are backwards\n compatible with v1). For more details, see BitTorrent v2 torrents.
\n-\n \n-[report issue]\n-void pause ();\n-bool is_paused () const;\n void resume ();\n+bool is_paused () const;\n+void pause ();\n\n
Pausing the session has the same effect as pausing every torrent in\n it, except that torrents will not be resumed by the auto-manage\n mechanism. Resuming will restore the torrents to their previous paused\n state. i.e. the session pause state is separate from the torrent pause\n state. A torrent is inactive if it is paused or if the session is\n paused.
\n@@ -2709,21 +2709,21 @@\n with the function object's context and make the function entirely\n self-contained. The only reason data blob's value is computed\n via a function instead of just passing in the new value is to avoid\n race conditions. If you want to update the value in the DHT, you\n must first retrieve it, then modify it, then write it back. The way\n the DHT works, it is natural to always do a lookup before storing and\n calling the callback in between is convenient.\n-\n-[report issue]\n-void dht_get_peers (sha1_hash const& info_hash);\n void dht_announce (sha1_hash const& info_hash, int port = 0, dht::announce_flags_t flags = {});\n+void dht_get_peers (sha1_hash const& info_hash);\n \n dht_get_peers() will issue a DHT get_peer request to the DHT for the\n specified info-hash. The response (the peers) will be posted back in a\n dht_get_peers_reply_alert.
\ndht_announce() will issue a DHT announce request to the DHT to the\n specified info-hash, advertising the specified port. If the port is\n left at its default, 0, the port will be implied by the DHT message's\n@@ -2830,34 +2830,34 @@\n
\n void set_port_filter (port_filter const& f);\n\n
apply port_filter f to incoming and outgoing peers. a port filter\n will reject making outgoing peer connections to certain remote ports.\n The main intention is to be able to avoid triggering certain\n anti-virus software by connecting to SMTP, FTP ports.
\n-\n+\n \n-[report issue]\n-bool is_listening () const;\n unsigned short listen_port () const;\n unsigned short ssl_listen_port () const;\n+bool is_listening () const;\n\n
is_listening() will tell you whether or not the session has\n successfully opened a listening port. If it hasn't, this function will\n return false, and then you can set a new\n settings_pack::listen_interfaces to try another interface and port to\n bind to.
\nlisten_port() returns the port we ended up listening on.
\n-\n-[report issue]\n void set_peer_class_filter (ip_filter const& f);\n ip_filter get_peer_class_filter () const;\n\n
Sets the peer class filter for this session. All new peer connections\n will take this into account and be added to the peer classes specified\n by this filter, based on the peer's IP address.
\n@@ -2933,18 +2933,18 @@\n remove the peer class if it's still assigned to torrents or peers. It\n will however remove it once the last peer and torrent drops their\n references to it.\nThere is no need to call this function for custom peer classes. All\n peer classes will be properly destructed when the session object\n destructs.
\nFor more information on peer classes, see peer classes.
\n-\n-[report issue]\n peer_class_info get_peer_class (peer_class_t cid) const;\n void set_peer_class (peer_class_t cid, peer_class_info const& pci);\n\n
These functions queries information from a peer class and updates the\n configuration of a peer class, respectively.
\ncid must refer to an existing peer class. If it does not, the\n@@ -2992,29 +2992,29 @@\n advised to remove them from the back of the queue, to minimize the\n shifting.
\n \n [report issue]\n-void apply_settings (settings_pack const&);\n-settings_pack get_settings () const;\n void apply_settings (settings_pack&&);\n+settings_pack get_settings () const;\n+void apply_settings (settings_pack const&);\n\n
Applies the settings specified by the settings_pack s. This is an\n asynchronous operation that will return immediately and actually apply\n the settings to the main thread of libtorrent some time later.
\n+\n \n-\n-[report issue]\n-void set_alert_notify (std::function<void()> const& fun);\n alert* wait_for_alert (time_duration max_wait);\n+void set_alert_notify (std::function<void()> const& fun);\n void pop_alerts (std::vector<alert*>* alerts);\n\n
Alerts is the main mechanism for libtorrent to report errors and\n events. pop_alerts fills in the vector passed to it with pointers\n to new alerts. The session still owns these alerts and they will stay\n valid until the next time pop_alerts is called. You may not delete\n the alert objects.
\n@@ -3141,20 +3141,20 @@\n [report issue]Declared in "libtorrent/session_params.hpp"
\n\n entry write_session_params (session_params const& sp\n , save_state_flags_t flags = save_state_flags_t::all());\n session_params read_session_params (span<char const> buf\n , save_state_flags_t flags = save_state_flags_t::all());\n std::vector<char> write_session_params_buf (session_params const& sp\n@@ -3292,35 +3292,35 @@\n\n\n-\n+torrent_info
\nDeclared in "libtorrent/torrent_info.hpp"
\nthe torrent_info class holds the information found in a .torrent file.
\n\n class torrent_info\n {\n+ torrent_info (std::string const& filename, load_torrent_limits const& cfg);\n+ torrent_info (bdecode_node const& torrent_file, load_torrent_limits const& cfg);\n+ torrent_info (span<char const> buffer, error_code& ec, from_span_t);\n+ torrent_info (std::string const& filename, error_code& ec);\n torrent_info (span<char const> buffer, load_torrent_limits const& cfg, from_span_t);\n torrent_info (bdecode_node const& torrent_file, error_code& ec);\n- torrent_info (span<char const> buffer, error_code& ec, from_span_t);\n- explicit torrent_info (info_hash_t const& info_hash);\n explicit torrent_info (std::string const& filename);\n- torrent_info (char const* buffer, int size);\n torrent_info (char const* buffer, int size, error_code& ec);\n- torrent_info (bdecode_node const& torrent_file, load_torrent_limits const& cfg);\n- explicit torrent_info (span<char const> buffer, from_span_t);\n+ torrent_info (char const* buffer, int size);\n+ explicit torrent_info (info_hash_t const& info_hash);\n torrent_info (torrent_info const& t);\n- torrent_info (std::string const& filename, error_code& ec);\n- torrent_info (std::string const& filename, load_torrent_limits const& cfg);\n explicit torrent_info (bdecode_node const& torrent_file);\n+ explicit torrent_info (span<char const> buffer, from_span_t);\n ~torrent_info ();\n file_storage const& orig_files () const;\n file_storage const& files () const;\n void rename_file (file_index_t index, std::string const& new_filename);\n void remap_files (file_storage const& f);\n+ void clear_trackers ();\n void add_tracker (std::string const& url, int tier\n , announce_entry::tracker_source source);\n- void clear_trackers ();\n void add_tracker (std::string const& url, int tier = 0);\n std::vector<announce_entry> const& trackers () const;\n std::vector<std::string> collections () const;\n std::vector<sha1_hash> similar_torrents () const;\n void add_url_seed (std::string const& url\n , std::string const& ext_auth = std::string()\n , web_seed_entry::headers_t const& ext_headers = web_seed_entry::headers_t());\n@@ -3328,32 +3328,32 @@\n void add_http_seed (std::string const& url\n , std::string const& extern_auth = std::string()\n , web_seed_entry::headers_t const& extra_headers = web_seed_entry::headers_t());\n void set_web_seeds (std::vector<web_seed_entry> seeds);\n std::int64_t total_size () const;\n int piece_length () const;\n int num_pieces () const;\n+ piece_index_t last_piece () const;\n index_range<piece_index_t> piece_range () const;\n piece_index_t end_piece () const;\n- piece_index_t last_piece () const;\n sha1_hash info_hash () const noexcept;\n info_hash_t const& info_hashes () const;\n- bool v2 () const;\n bool v1 () const;\n+ bool v2 () const;\n int num_files () const;\n std::vector<file_slice> map_block (piece_index_t const piece\n , std::int64_t offset, int size) const;\n peer_request map_file (file_index_t const file, std::int64_t offset, int size) const;\n string_view ssl_cert () const;\n bool is_valid () const;\n bool priv () const;\n bool is_i2p () const;\n int piece_size (piece_index_t index) const;\n- sha1_hash hash_for_piece (piece_index_t index) const;\n char const* hash_for_piece_ptr (piece_index_t const index) const;\n+ sha1_hash hash_for_piece (piece_index_t index) const;\n bool is_loaded () const;\n const std::string& name () const;\n std::time_t creation_date () const;\n const std::string& creator () const;\n const std::string& comment () const;\n std::vector<std::pair<std::string, int>> const& nodes () const;\n void add_node (std::pair<std::string, int> const& node);\n@@ -3363,27 +3363,27 @@\n span<char const> piece_layer (file_index_t) const;\n void free_piece_layers ();\n };\n\n [report issue]\n\ntorrent_info()
\n\n+torrent_info (std::string const& filename, load_torrent_limits const& cfg);\n+torrent_info (bdecode_node const& torrent_file, load_torrent_limits const& cfg);\n+torrent_info (span<char const> buffer, error_code& ec, from_span_t);\n+torrent_info (std::string const& filename, error_code& ec);\n torrent_info (span<char const> buffer, load_torrent_limits const& cfg, from_span_t);\n torrent_info (bdecode_node const& torrent_file, error_code& ec);\n-torrent_info (span<char const> buffer, error_code& ec, from_span_t);\n-explicit torrent_info (info_hash_t const& info_hash);\n explicit torrent_info (std::string const& filename);\n-torrent_info (char const* buffer, int size);\n torrent_info (char const* buffer, int size, error_code& ec);\n-torrent_info (bdecode_node const& torrent_file, load_torrent_limits const& cfg);\n-explicit torrent_info (span<char const> buffer, from_span_t);\n+torrent_info (char const* buffer, int size);\n+explicit torrent_info (info_hash_t const& info_hash);\n torrent_info (torrent_info const& t);\n-torrent_info (std::string const& filename, error_code& ec);\n-torrent_info (std::string const& filename, load_torrent_limits const& cfg);\n explicit torrent_info (bdecode_node const& torrent_file);\n+explicit torrent_info (span<char const> buffer, from_span_t);\n\nThe constructor that takes an info-hash will initialize the info-hash\n to the given value, but leave all other fields empty. This is used\n internally when downloading torrents without the metadata. The\n metadata will be created by libtorrent as soon as it has been\n downloaded from the swarm.
\nThe constructor that takes a bdecode_node will create a torrent_info\n@@ -3412,18 +3412,18 @@\n [report issue]
\n\n-\n+~torrent_info()
\n\n ~torrent_info ();\n\nfrees all storage associated with this torrent_info object
\n-\n-[report issue]\n+\nfiles() orig_files()
\n\n file_storage const& orig_files () const;\n file_storage const& files () const;\n\nThe file_storage object contains the information on how to map the\n pieces to files. It is separated from the torrent_info object because\n when creating torrents a storage object needs to be created without\n@@ -3470,23 +3470,23 @@\n
Remaps the file storage to a new file layout. This can be used to, for\n instance, download all data in a torrent to a single file, or to a\n number of fixed size sector aligned files, regardless of the number\n and sizes of the files in the torrent.
\nThe new specified file_storage must have the exact same size as\n the current one.
\n-\n \n-[report issue]\n+\n-\n+add_tracker() clear_trackers() trackers()
\n\n+void clear_trackers ();\n void add_tracker (std::string const& url, int tier\n , announce_entry::tracker_source source);\n-void clear_trackers ();\n void add_tracker (std::string const& url, int tier = 0);\n std::vector<announce_entry> const& trackers () const;\n\nadd_tracker() adds a tracker to the announce-list. The tier\n determines the order in which the trackers are to be tried.\n The trackers() function will return a sorted vector of\n announce_entry. Each announce entry contains a string, which is\n@@ -3505,20 +3505,20 @@\n std::vector<sha1_hash> similar_torrents () const;\n \n
These two functions are related to BEP 38 (mutable torrents). The\n vectors returned from these correspond to the "similar" and\n "collections" keys in the .torrent file. Both info-hashes and\n collections from within the info-dict and from outside of it are\n included.
\n-\n \n \n-[report issue]\n+\n-\n+set_web_seeds() add_url_seed() add_http_seed() web_seeds()
\n\n void add_url_seed (std::string const& url\n , std::string const& ext_auth = std::string()\n , web_seed_entry::headers_t const& ext_headers = web_seed_entry::headers_t());\n std::vector<web_seed_entry> const& web_seeds () const;\n void add_http_seed (std::string const& url\n , std::string const& extern_auth = std::string()\n@@ -3547,63 +3547,63 @@\n std::int64_t total_size () const;\n\ntotal_size() returns the total number of bytes the torrent-file\n represents. Note that this is the number of pieces times the piece\n size (modulo the last piece possibly being smaller). With pad files,\n the total size will be larger than the sum of all (regular) file\n sizes.
\n-\n-[report issue]\n+\n-\n+piece_length() num_pieces()
\n\n int piece_length () const;\n int num_pieces () const;\n\npiece_length() and num_pieces() returns the number of byte\n for each piece and the total number of pieces, respectively. The\n difference between piece_size() and piece_length() is that\n piece_size() takes the piece index as argument and gives you the\n exact size of that piece. It will always be the same as\n piece_length() except in the case of the last piece, which may be\n smaller.
\n-\n \n-[report issue]\n+\n-\n+last_piece() end_piece() piece_range()
\n\n+piece_index_t last_piece () const;\n index_range<piece_index_t> piece_range () const;\n piece_index_t end_piece () const;\n-piece_index_t last_piece () const;\n\nlast_piece() returns the index to the last piece in the torrent and\n end_piece() returns the index to the one-past-end piece in the\n torrent\n piece_range() returns an implementation-defined type that can be\n used as the container in a range-for loop. Where the values are the\n indices of all pieces in the file_storage.
\n-\n-[report issue]\n+\ninfo_hashes() info_hash()
\n\n sha1_hash info_hash () const noexcept;\n info_hash_t const& info_hashes () const;\n\nreturns the info-hash of the torrent. For BitTorrent v2 support, use\n info_hashes() to get an object that may hold both a v1 and v2\n info-hash
\n \n [report issue]\n\nv1() v2()
\n\n-bool v2 () const;\n bool v1 () const;\n+bool v2 () const;\n\nreturns whether this torrent has v1 and/or v2 metadata, respectively.\n Hybrid torrents have both. These are shortcuts for\n info_hashes().has_v1() and info_hashes().has_v2() calls.
\n [report issue]\n\nnum_files()
\n@@ -3676,21 +3676,21 @@\n\n\n-\n+piece_size()
\n\n int piece_size (piece_index_t index) const;\n\nreturns the piece size of file with index. This will be the same as piece_length(),\n except for the last piece, which may be shorter.
\n-\n-[report issue]\n+\n@@ -4286,20 +4286,20 @@\nhash_for_piece_ptr() hash_for_piece()
\n\n-sha1_hash hash_for_piece (piece_index_t index) const;\n char const* hash_for_piece_ptr (piece_index_t const index) const;\n+sha1_hash hash_for_piece (piece_index_t index) const;\n\nhash_for_piece() takes a piece-index and returns the 20-bytes\n sha1-hash for that piece and info_hash() returns the 20-bytes\n sha1-hash for the info-section of the torrent file.\n hash_for_piece_ptr() returns a pointer to the 20 byte sha1 digest\n for the piece. Note that the string is not 0-terminated.
\n [report issue]Note
\nIf has_v2() is false then the v1 hash might actually be a truncated\n v2 hash
\n\n struct info_hash_t\n {\n- explicit info_hash_t (sha256_hash h2) noexcept;\n- info_hash_t () noexcept = default;\n explicit info_hash_t (sha1_hash h1) noexcept;\n+ info_hash_t () noexcept = default;\n info_hash_t (sha1_hash h1, sha256_hash h2) noexcept;\n- bool has (protocol_version v) const;\n+ explicit info_hash_t (sha256_hash h2) noexcept;\n bool has_v2 () const;\n+ bool has (protocol_version v) const;\n bool has_v1 () const;\n sha1_hash get (protocol_version v) const;\n sha1_hash get_best () const;\n friend bool operator!= (info_hash_t const& lhs, info_hash_t const& rhs);\n friend bool operator== (info_hash_t const& lhs, info_hash_t const& rhs) noexcept;\n template <typename F> void for_each (F f) const;\n bool operator< (info_hash_t const& o) const;\n@@ -4308,32 +4308,32 @@\n sha1_hash v1;\n sha256_hash v2;\n };\n\n [report issue]\n\ninfo_hash_t()
\n\n-explicit info_hash_t (sha256_hash h2) noexcept;\n-info_hash_t () noexcept = default;\n explicit info_hash_t (sha1_hash h1) noexcept;\n+info_hash_t () noexcept = default;\n info_hash_t (sha1_hash h1, sha256_hash h2) noexcept;\n+explicit info_hash_t (sha256_hash h2) noexcept;\n\nThe default constructor creates an object that has neither a v1 or v2\n hash.
\nFor backwards compatibility, make it possible to construct directly\n from a v1 hash. This constructor allows implicit conversion from a\n v1 hash, but the implicitness is deprecated.
\n \n \n [report issue]\n\nhas() has_v1() has_v2()
\n\n-bool has (protocol_version v) const;\n bool has_v2 () const;\n+bool has (protocol_version v) const;\n bool has_v1 () const;\n\nreturns true if the corresponding info hash is present in this\n object.
\n [report issue]\n\n+\n+[report issue]get()
\n@@ -4410,34 +4410,34 @@\nstart \nThe byte offset within that piece where the range starts. \n \n [report issue]\n
\n-\n \n-[report issue]- length
\n- The size of the range, in bytes.
\n
Declared in "libtorrent/load_torrent.hpp"
\n\n-add_torrent_params load_torrent_parsed (\n- bdecode_node const& torrent_file, load_torrent_limits const& cfg);\n-add_torrent_params load_torrent_buffer (\n- span<char const> buffer, load_torrent_limits const& cfg);\n add_torrent_params load_torrent_file (\n std::string const& filename, load_torrent_limits const& cfg);\n+add_torrent_params load_torrent_buffer (\n+ span<char const> buffer, load_torrent_limits const& cfg);\n+add_torrent_params load_torrent_parsed (\n+ bdecode_node const& torrent_file, load_torrent_limits const& cfg);\n+add_torrent_params load_torrent_parsed (\n+ bdecode_node const& torrent_file);\n add_torrent_params load_torrent_file (\n std::string const& filename);\n add_torrent_params load_torrent_buffer (\n span<char const> buffer);\n-add_torrent_params load_torrent_parsed (\n- bdecode_node const& torrent_file);\n\n
These functions load the content of a .torrent file into an\n add_torrent_params object.\n The immutable part of a torrent file (the info-dictionary) is stored in\n the ti field in the add_torrent_params object (as a torrent_info\n object).\n The returned object is suitable to be:
\n@@ -4449,16 +4449,16 @@\n \n \n [report issue]Declared in "libtorrent/magnet_uri.hpp"
\n\n-std::string make_magnet_uri (torrent_handle const& handle);\n std::string make_magnet_uri (torrent_info const& info);\n+std::string make_magnet_uri (torrent_handle const& handle);\n std::string make_magnet_uri (add_torrent_params const& atp);\n\n
Generates a magnet URI from the specified torrent.
\nSeveral fields from the add_torrent_params objects are recorded in the\n magnet link. In order to not include them, they have to be cleared before\n calling make_magnet_uri(). These fields are used:
\n\n@@ -4479,17 +4479,17 @@\n an empty string is returned.\nFor more information about magnet links, see magnet links.
\n [report issue]
Declared in "libtorrent/magnet_uri.hpp"
\n\n+void parse_magnet_uri (string_view uri, add_torrent_params& p, error_code& ec);\n add_torrent_params parse_magnet_uri (string_view uri);\n add_torrent_params parse_magnet_uri (string_view uri, error_code& ec);\n-void parse_magnet_uri (string_view uri, add_torrent_params& p, error_code& ec);\n\n
This function parses out information from the magnet link and populates the\n add_torrent_params object. The overload that does not take an\n error_code reference will throw a system_error on error\n The overload taking an add_torrent_params reference will fill in the\n fields specified in the magnet URI.
\n [report issue]Torrent plugins are associated with a single torrent and have a number\n of functions called at certain events. Many of its functions have the\n ability to change or override the default libtorrent behavior.
\n\n struct torrent_plugin\n {\n virtual std::shared_ptr<peer_plugin> new_connection (peer_connection_handle const&);\n- virtual void on_piece_failed (piece_index_t);\n virtual void on_piece_pass (piece_index_t);\n+ virtual void on_piece_failed (piece_index_t);\n virtual void tick ();\n virtual bool on_pause ();\n virtual bool on_resume ();\n virtual void on_files_checked ();\n virtual void on_state (torrent_status::state_t);\n virtual void on_add_peer (tcp::endpoint const&,\n peer_source_flags_t, add_peer_flags_t);\n@@ -5311,33 +5311,33 @@\n to it, use weak_ptr.\n If this function throws an exception, the connection will be closed.
\n \n [report issue]\n-virtual void on_piece_failed (piece_index_t);\n virtual void on_piece_pass (piece_index_t);\n+virtual void on_piece_failed (piece_index_t);\n\n
These hooks are called when a piece passes the hash check or fails the hash\n check, respectively. The index is the piece index that was downloaded.\n It is possible to access the list of peers that participated in sending the\n piece through the torrent and the piece_picker.
\n [report issue]\n virtual void tick ();\n\n
This hook is called approximately once per second. It is a way of making it\n easy for plugins to do timed events, for sending messages or whatever.
\n-\n-[report issue]\n virtual bool on_pause ();\n virtual bool on_resume ();\n\n
These hooks are called when the torrent is paused and resumed respectively.\n The return value indicates if the event was handled. A return value of\n true indicates that it was handled, and no other plugin after this one\n@@ -5405,51 +5405,51 @@\n {\n virtual string_view type () const;\n virtual void add_handshake (entry&);\n virtual void on_disconnect (error_code const&);\n virtual void on_connected ();\n virtual bool on_handshake (span<char const>);\n virtual bool on_extension_handshake (bdecode_node const&);\n- virtual bool on_have_all ();\n- virtual bool on_unchoke ();\n- virtual bool on_choke ();\n- virtual bool on_interested ();\n- virtual bool on_request (peer_request const&);\n- virtual bool on_bitfield (bitfield const& /*bitfield*/);\n virtual bool on_not_interested ();\n- virtual bool on_have (piece_index_t);\n+ virtual bool on_have_none ();\n virtual bool on_dont_have (piece_index_t);\n+ virtual bool on_have (piece_index_t);\n virtual bool on_allowed_fast (piece_index_t);\n- virtual bool on_have_none ();\n+ virtual bool on_interested ();\n+ virtual bool on_bitfield (bitfield const& /*bitfield*/);\n+ virtual bool on_choke ();\n+ virtual bool on_request (peer_request const&);\n+ virtual bool on_have_all ();\n+ virtual bool on_unchoke ();\n virtual bool on_piece (peer_request const& /*piece*/\n , span<char const> /*buf*/);\n- virtual bool on_cancel (peer_request const&);\n- virtual bool on_reject (peer_request const&);\n virtual bool on_suggest (piece_index_t);\n- virtual void sent_cancel (peer_request const&);\n- virtual void sent_have_all ();\n+ virtual bool on_reject (peer_request const&);\n+ virtual bool on_cancel (peer_request const&);\n virtual void sent_suggest (piece_index_t);\n+ virtual void sent_reject_request (peer_request const&);\n+ virtual void sent_request (peer_request const&);\n+ virtual void sent_have_all ();\n+ virtual void sent_cancel (peer_request const&);\n virtual void sent_choke ();\n virtual void sent_have_none ();\n virtual void sent_allow_fast (piece_index_t);\n- virtual void sent_reject_request (peer_request const&);\n- virtual void sent_request (peer_request const&);\n- virtual void sent_not_interested ();\n virtual void sent_unchoke ();\n virtual void sent_interested ();\n+ virtual void sent_not_interested ();\n virtual void sent_have (piece_index_t);\n virtual void sent_piece (peer_request const&);\n virtual void sent_payload (int /* bytes */);\n virtual bool can_disconnect (error_code const& /*ec*/);\n virtual bool on_extended (int /*length*/, int /*msg*/,\n span<char const> /*body*/);\n virtual bool on_unknown_message (int /*length*/, int /*msg*/,\n span<char const> /*body*/);\n- virtual void on_piece_failed (piece_index_t);\n virtual void on_piece_pass (piece_index_t);\n+ virtual void on_piece_failed (piece_index_t);\n virtual void tick ();\n virtual bool write_request (peer_request const&);\n };\n \n [report issue]
\n@@ -5499,39 +5499,39 @@\n virtual bool on_extension_handshake (bdecode_node const&);\n\n
called when the extension handshake from the other end is received\n if this returns false, it means that this extension isn't\n supported by this peer. It will result in this peer_plugin\n being removed from the peer_connection and destructed.\n this is not called for web seeds
\n+\n+\n \n \n-\n-\n-\n \n-\n-\n \n+\n+\n+\n \n-[report issue]\n-virtual bool on_have_all ();\n-virtual bool on_unchoke ();\n-virtual bool on_choke ();\n-virtual bool on_interested ();\n-virtual bool on_request (peer_request const&);\n-virtual bool on_bitfield (bitfield const& /*bitfield*/);\n virtual bool on_not_interested ();\n-virtual bool on_have (piece_index_t);\n+virtual bool on_have_none ();\n virtual bool on_dont_have (piece_index_t);\n+virtual bool on_have (piece_index_t);\n virtual bool on_allowed_fast (piece_index_t);\n-virtual bool on_have_none ();\n+virtual bool on_interested ();\n+virtual bool on_bitfield (bitfield const& /*bitfield*/);\n+virtual bool on_choke ();\n+virtual bool on_request (peer_request const&);\n+virtual bool on_have_all ();\n+virtual bool on_unchoke ();\n\n
returning true from any of the message handlers\n indicates that the plugin has handled the message.\n it will break the plugin chain traversing and not let\n anyone else handle the message, including the default\n handler.
\n [report issue]This function is called when the peer connection is receiving\n a piece. buf points (non-owning pointer) to the data in an\n internal immutable disk buffer. The length of the data is specified\n in the length member of the piece parameter.\n returns true to indicate that the piece is handled and the\n rest of the logic should be ignored.
\n-\n-\n \n+\n \n-[report issue]\n-virtual void sent_not_interested ();\n virtual void sent_unchoke ();\n virtual void sent_interested ();\n+virtual void sent_not_interested ();\n virtual void sent_have (piece_index_t);\n virtual void sent_piece (peer_request const&);\n\n
called after a choke message has been sent to the peer
\n [report issue]this is not called for web seeds
\n \n [report issue]\n-virtual void on_piece_failed (piece_index_t);\n virtual void on_piece_pass (piece_index_t);\n+virtual void on_piece_failed (piece_index_t);\n\n
called when a piece that this peer participated in either\n fails or passes the hash_check
\n [report issue]\n@@ -5633,16 +5633,16 @@\n
Declared in "libtorrent/extensions.hpp"
\n\n struct crypto_plugin\n {\n- virtual void set_incoming_key (span<char const> key) = 0;\n virtual void set_outgoing_key (span<char const> key) = 0;\n+ virtual void set_incoming_key (span<char const> key) = 0;\n encrypt (span<span<char>> /*send_vec*/) = 0;\n virtual std::tuple<int, int, int> decrypt (span<span<char>> /*receive_vec*/) = 0;\n };\n \n [report issue]\n@@ -5666,50 +5666,50 @@\n connection object, to be used by plugins. This is a low level interface that\n may not be stable across libtorrent versions\n \n struct peer_connection_handle\n {\n explicit peer_connection_handle (std::weak_ptr<peer_connection> impl);\n connection_type type () const;\n- void add_extension (std::shared_ptr<peer_plugin>);\n peer_plugin const* find_plugin (string_view type) const;\n+ void add_extension (std::shared_ptr<peer_plugin>);\n bool is_seed () const;\n bool upload_only () const;\n- peer_id const& pid () const;\n bool has_piece (piece_index_t i) const;\n+ peer_id const& pid () const;\n bool is_interesting () const;\n bool is_choked () const;\n- bool has_peer_choked () const;\n bool is_peer_interested () const;\n- void maybe_unchoke_this_peer ();\n+ bool has_peer_choked () const;\n void choke_this_peer ();\n+ void maybe_unchoke_this_peer ();\n void get_peer_info (peer_info& p) const;\n torrent_handle associated_torrent () const;\n- tcp::endpoint const& remote () const;\n tcp::endpoint local_endpoint () const;\n- bool is_connecting () const;\n+ tcp::endpoint const& remote () const;\n bool is_outgoing () const;\n+ bool is_disconnecting () const;\n+ bool is_connecting () const;\n void disconnect (error_code const& ec, operation_t op\n , disconnect_severity_t = peer_connection_interface::normal);\n- bool is_disconnecting () const;\n bool on_local_network () const;\n bool ignore_unchoke_slots () const;\n bool failed () const;\n- bool should_log (peer_log_alert::direction_t direction) const;\n void peer_log (peer_log_alert::direction_t direction\n , char const* event, char const* fmt = "", ...) const TORRENT_FORMAT(4,5);\n+ bool should_log (peer_log_alert::direction_t direction) const;\n bool can_disconnect (error_code const& ec) const;\n bool has_metadata () const;\n bool in_handshake () const;\n void send_buffer (char const* begin, int size);\n time_point time_of_last_unchoke () const;\n std::time_t last_seen_complete () const;\n bool operator< (peer_connection_handle const& o) const;\n- bool operator!= (peer_connection_handle const& o) const;\n bool operator== (peer_connection_handle const& o) const;\n+ bool operator!= (peer_connection_handle const& o) const;\n std::shared_ptr<peer_connection> native_handle () const;\n };\n \n [report issue]Declared in "libtorrent/peer_connection_handle.hpp"
\n@@ -5719,16 +5719,16 @@\n\n struct bt_peer_connection_handle : peer_connection_handle\n {\n explicit bt_peer_connection_handle (peer_connection_handle pc);\n bool support_extensions () const;\n bool packet_finished () const;\n bool supports_encryption () const;\n- void switch_send_crypto (std::shared_ptr<crypto_plugin> crypto);\n void switch_recv_crypto (std::shared_ptr<crypto_plugin> crypto);\n+ void switch_send_crypto (std::shared_ptr<crypto_plugin> crypto);\n std::shared_ptr<bt_peer_connection> native_handle () const;\n };\n \n [report issue]Declared in "libtorrent/extensions/ut_pex.hpp"
\n@@ -5808,75 +5808,75 @@\n size. Everything necessary to interpret a regular bittorrent storage\n file structure.\n\n class file_storage\n {\n bool is_valid () const;\n void reserve (int num_files);\n- void add_file (std::string const& path, std::int64_t file_size\n- , file_flags_t file_flags = {}\n- , std::time_t mtime = 0, string_view symlink_path = string_view()\n- , char const* root_hash = nullptr);\n void add_file (error_code& ec, std::string const& path, std::int64_t file_size\n , file_flags_t file_flags = {}\n , std::time_t mtime = 0, string_view symlink_path = string_view()\n , char const* root_hash = nullptr);\n- void add_file_borrow (error_code& ec, string_view filename\n+ void add_file_borrow (string_view filename\n , std::string const& path, std::int64_t file_size\n , file_flags_t file_flags = {}, char const* filehash = nullptr\n , std::int64_t mtime = 0, string_view symlink_path = string_view()\n , char const* root_hash = nullptr);\n- void add_file_borrow (string_view filename\n+ void add_file (std::string const& path, std::int64_t file_size\n+ , file_flags_t file_flags = {}\n+ , std::time_t mtime = 0, string_view symlink_path = string_view()\n+ , char const* root_hash = nullptr);\n+ void add_file_borrow (error_code& ec, string_view filename\n , std::string const& path, std::int64_t file_size\n , file_flags_t file_flags = {}, char const* filehash = nullptr\n , std::int64_t mtime = 0, string_view symlink_path = string_view()\n , char const* root_hash = nullptr);\n void rename_file (file_index_t index, std::string const& new_filename);\n std::vector<file_slice> map_block (piece_index_t piece, std::int64_t offset\n , std::int64_t size) const;\n peer_request map_file (file_index_t file, std::int64_t offset, int size) const;\n int num_files () const noexcept;\n file_index_t end_file () const noexcept;\n index_range<file_index_t> file_range () const noexcept;\n std::int64_t total_size () const;\n- void set_num_pieces (int n);\n int num_pieces () const;\n+ void set_num_pieces (int n);\n piece_index_t end_piece () const;\n piece_index_t last_piece () const;\n index_range<piece_index_t> piece_range () const noexcept;\n int piece_length () const;\n void set_piece_length (int l);\n int piece_size (piece_index_t index) const;\n int piece_size2 (piece_index_t index) const;\n int blocks_in_piece2 (piece_index_t index) const;\n std::string const& name () const;\n void set_name (std::string const& n);\n void swap (file_storage& ti) noexcept;\n void canonicalize ();\n- sha1_hash hash (file_index_t index) const;\n- bool pad_file_at (file_index_t index) const;\n sha256_hash root (file_index_t index) const;\n char const* root_ptr (file_index_t const index) const;\n- std::string symlink (file_index_t index) const;\n- std::string file_path (file_index_t index, std::string const& save_path = "") const;\n- std::int64_t file_offset (file_index_t index) const;\n- std::int64_t file_size (file_index_t index) const;\n string_view file_name (file_index_t index) const;\n+ std::int64_t file_size (file_index_t index) const;\n+ std::string file_path (file_index_t index, std::string const& save_path = "") const;\n+ std::string symlink (file_index_t index) const;\n+ sha1_hash hash (file_index_t index) const;\n std::time_t mtime (file_index_t index) const;\n+ std::int64_t file_offset (file_index_t index) const;\n+ bool pad_file_at (file_index_t index) const;\n+ int file_num_pieces (file_index_t index) const;\n index_range<piece_index_t::diff_type> file_piece_range (file_index_t) const;\n int file_num_blocks (file_index_t index) const;\n- int file_num_pieces (file_index_t index) const;\n int file_first_block_node (file_index_t index) const;\n int file_first_piece_node (file_index_t index) const;\n std::uint32_t file_path_hash (file_index_t index, std::string const& save_path) const;\n void all_path_hashes (std::unordered_set<std::uint32_t>& table) const;\n file_flags_t file_flags (file_index_t index) const;\n bool file_absolute_path (file_index_t index) const;\n- file_index_t file_index_at_offset (std::int64_t offset) const;\n file_index_t file_index_at_piece (piece_index_t piece) const;\n+ file_index_t file_index_at_offset (std::int64_t offset) const;\n file_index_t file_index_for_root (sha256_hash const& root_hash) const;\n piece_index_t piece_index_at_file (file_index_t f) const;\n void sanitize_symlinks ();\n bool v2 () const;\n \n static constexpr file_flags_t flag_pad_file = 0_bit;\n static constexpr file_flags_t flag_hidden = 1_bit;\n@@ -5903,28 +5903,28 @@\n be used to avoid reallocating the internal file list when the number\n of files to be added is known up-front.\n \n [report issue]\n-void add_file (std::string const& path, std::int64_t file_size\n- , file_flags_t file_flags = {}\n- , std::time_t mtime = 0, string_view symlink_path = string_view()\n- , char const* root_hash = nullptr);\n void add_file (error_code& ec, std::string const& path, std::int64_t file_size\n , file_flags_t file_flags = {}\n , std::time_t mtime = 0, string_view symlink_path = string_view()\n , char const* root_hash = nullptr);\n-void add_file_borrow (error_code& ec, string_view filename\n+void add_file_borrow (string_view filename\n , std::string const& path, std::int64_t file_size\n , file_flags_t file_flags = {}, char const* filehash = nullptr\n , std::int64_t mtime = 0, string_view symlink_path = string_view()\n , char const* root_hash = nullptr);\n-void add_file_borrow (string_view filename\n+void add_file (std::string const& path, std::int64_t file_size\n+ , file_flags_t file_flags = {}\n+ , std::time_t mtime = 0, string_view symlink_path = string_view()\n+ , char const* root_hash = nullptr);\n+void add_file_borrow (error_code& ec, string_view filename\n , std::string const& path, std::int64_t file_size\n , file_flags_t file_flags = {}, char const* filehash = nullptr\n , std::int64_t mtime = 0, string_view symlink_path = string_view()\n , char const* root_hash = nullptr);\n \n Adds a file to the file storage. The add_file_borrow version\n expects that filename is the file name (without a path) of\n@@ -6026,21 +6026,21 @@\n [report issue]
\n std::int64_t total_size () const;\n\n
returns the total number of bytes all the files in this torrent spans
\n-\n-[report issue]\n-void set_num_pieces (int n);\n int num_pieces () const;\n+void set_num_pieces (int n);\n\n
set and get the number of pieces in the torrent
\n [report issue]\n piece_index_t end_piece () const;\n@@ -6060,18 +6060,18 @@\npiece_range()
\n\n index_range<piece_index_t> piece_range () const noexcept;\n\nreturns an implementation-defined type that can be used as the\n container in a range-for loop. Where the values are the indices of all\n pieces in the file_storage.
\n-\n-[report issue]
\n int piece_length () const;\n void set_piece_length (int l);\n\n
set and get the size of each piece in this torrent. It must be a power of two\n and at least 16 kiB.
\n [report issue]\n int blocks_in_piece2 (piece_index_t index) const;\n\n
returns the number of blocks in the specified piece, for v2 torrents.
\n-\n-[report issue]\n std::string const& name () const;\n void set_name (std::string const& n);\n\n
set and get the name of this torrent. For multi-file torrents, this is also\n the name of the root directory all the files are stored in.
\n [report issue]\n void canonicalize ();\n\n
arrange files and padding to match the canonical form required\n by BEP 52
\n \n-\n-\n-\n-\n \n+\n+\n+\n \n \n-\n-[report issue]\n-sha1_hash hash (file_index_t index) const;\n-bool pad_file_at (file_index_t index) const;\n sha256_hash root (file_index_t index) const;\n char const* root_ptr (file_index_t const index) const;\n-std::string symlink (file_index_t index) const;\n-std::string file_path (file_index_t index, std::string const& save_path = "") const;\n-std::int64_t file_offset (file_index_t index) const;\n-std::int64_t file_size (file_index_t index) const;\n string_view file_name (file_index_t index) const;\n+std::int64_t file_size (file_index_t index) const;\n+std::string file_path (file_index_t index, std::string const& save_path = "") const;\n+std::string symlink (file_index_t index) const;\n+sha1_hash hash (file_index_t index) const;\n std::time_t mtime (file_index_t index) const;\n+std::int64_t file_offset (file_index_t index) const;\n+bool pad_file_at (file_index_t index) const;\n\n
These functions are used to query attributes of files at\n a given index.
\nThe hash() is a SHA-1 hash of the file, or 0 if none was\n provided in the torrent file. This can potentially be used to\n join a bittorrent network with other file sharing networks.
\nroot() returns the SHA-256 merkle tree root of the specified file,\n@@ -6169,33 +6169,33 @@\n
file_name() returns just the name of the file, whereas\n file_path() returns the path (inside the torrent file) with\n the filename appended.
\nfile_offset() returns the byte offset within the torrent file\n where this file starts. It can be used to map the file to a piece\n index (given the piece size).
\n \n-\n-[report issue]\n+int file_num_pieces (file_index_t index) const;\n index_range<piece_index_t::diff_type> file_piece_range (file_index_t) const;\n int file_num_blocks (file_index_t index) const;\n-int file_num_pieces (file_index_t index) const;\n\n
Returns the number of pieces or blocks the file at index spans,\n under the assumption that the file is aligned to the start of a piece.\n This is only meaningful for v2 torrents, where files are guaranteed\n such alignment.\n These numbers are used to size and navigate the merkle hash tree for\n each file.
\n-\n-[report issue]\n int file_first_block_node (file_index_t index) const;\n int file_first_piece_node (file_index_t index) const;\n\n
index of first piece node in the merkle tree
\n [report issue]\n bool file_absolute_path (file_index_t index) const;\n\n
returns true if the file at the specified index has been renamed to\n have an absolute path, i.e. is not anchored in the save path of the\n torrent.
\n-\n-[report issue]\n-file_index_t file_index_at_offset (std::int64_t offset) const;\n file_index_t file_index_at_piece (piece_index_t piece) const;\n+file_index_t file_index_at_offset (std::int64_t offset) const;\n\n
returns the index of the file at the given offset in the torrent
\n [report issue]\n file_index_t file_index_for_root (sha256_hash const& root_hash) const;\n@@ -6480,38 +6480,38 @@\n struct client_data_t\n {\n client_data_t () = default;\n explicit client_data_t (T* v);\n client_data_t& operator= (T* v);\n explicit operator T () const;\n T* get () const;\n- client_data_t& operator= (void const*) = delete;\n+ client_data_t& operator= (void*) = delete;\n operator void const* () const = delete;\n operator void* () const = delete;\n- client_data_t& operator= (void*) = delete;\n+ client_data_t& operator= (void const*) = delete;\n \n template <typename T, typename U = typename std::enable_if<std::is_pointer<T>::value>::type>\n };\n \n [report issue]\n client_data_t () = default;\n\n
construct a nullptr client data
\n-\n+\n \n-[report issue]\n-client_data_t& operator= (void const*) = delete;\n+client_data_t& operator= (void*) = delete;\n operator void const* () const = delete;\n operator void* () const = delete;\n-client_data_t& operator= (void*) = delete;\n+client_data_t& operator= (void const*) = delete;\n\n
we don't allow type-unsafe operations
\n [report issue]Declared in "libtorrent/add_torrent_params.hpp"
\n@@ -6896,16 +6896,16 @@\n peer-classes from peers. It is applied after the peer class filter is applied (which\n is based on the peer's IP address).\n\n struct peer_class_type_filter\n {\n void add (socket_type_t const st, peer_class_t const peer_class);\n void remove (socket_type_t const st, peer_class_t const peer_class);\n- void disallow (socket_type_t const st, peer_class_t const peer_class);\n void allow (socket_type_t const st, peer_class_t const peer_class);\n+ void disallow (socket_type_t const st, peer_class_t const peer_class);\n std::uint32_t apply (socket_type_t const st, std::uint32_t peer_class_mask);\n friend bool operator== (peer_class_type_filter const& lhs\n , peer_class_type_filter const& rhs);\n \n enum socket_type_t\n {\n tcp_socket,\n@@ -6922,21 +6922,21 @@\n remove() add()
\n \n void add (socket_type_t const st, peer_class_t const peer_class);\n void remove (socket_type_t const st, peer_class_t const peer_class);\n
\n add() and remove() adds and removes a peer class to be added\n to new peers based on socket type.
\n-\n-[report issue]\n-void disallow (socket_type_t const st, peer_class_t const peer_class);\n void allow (socket_type_t const st, peer_class_t const peer_class);\n+void disallow (socket_type_t const st, peer_class_t const peer_class);\n\n
disallow() and allow() adds and removes a peer class to be\n removed from new peers based on socket type.
\nThe peer_class argument cannot be greater than 31. The bitmasks representing\n peer classes in the peer_class_type_filter are 32 bits.
\n [report issue]\n void set_peer (tcp::endpoint const& ep);\n tcp::endpoint peer () const;\n\n
The peer is the ip address of the peer this block was downloaded from.
\n [report issue]get_download_queue() returns a vector with information about pieces\n that are partially downloaded or not downloaded but partially\n requested. See partial_piece_info for the fields in the returned\n vector.
\n-\n \n-[report issue]\n-void clear_piece_deadlines () const;\n-void reset_piece_deadline (piece_index_t index) const;\n void set_piece_deadline (piece_index_t index, int deadline, deadline_flags_t flags = {}) const;\n+void reset_piece_deadline (piece_index_t index) const;\n+void clear_piece_deadlines () const;\n \n This function sets or resets the deadline associated with a specific\n piece index (index). libtorrent will attempt to download this\n entire piece before the deadline expires. This is not necessarily\n possible, but pieces with a more recent deadline will always be\n prioritized over pieces with a deadline further ahead in time. The\n deadline (and flags) of a piece can be changed by calling this\n@@ -7401,16 +7401,16 @@\n priority.
\nclear_piece_deadlines() removes deadlines on all pieces in\n the torrent. As if reset_piece_deadline() was called on all pieces.
\n [report issue]\n-void file_progress (std::vector<std::int64_t>& progress, file_progress_flags_t flags = {}) const;\n std::vector<std::int64_t> file_progress (file_progress_flags_t flags = {}) const;\n+void file_progress (std::vector<std::int64_t>& progress, file_progress_flags_t flags = {}) const;\n \n This function fills in the supplied vector, or returns a vector, with\n the number of bytes downloaded of each file in this torrent. The\n progress values are ordered the same as the files in the\n torrent_info.
\nThis operation is not very cheap. Its complexity is O(n + mj).\n Where n is the number of files, m is the number of currently\n@@ -7439,22 +7439,22 @@\n
\n void clear_error () const;\n\n
If the torrent is in an error state (i.e. torrent_status::error is\n non-empty), this will clear the error and start the torrent again.
\n-\n \n-[report issue]\n-void replace_trackers (std::vector<announce_entry> const&) const;\n void add_tracker (announce_entry const&) const;\n+void replace_trackers (std::vector<announce_entry> const&) const;\n std::vector<announce_entry> trackers () const;\n\n
trackers() will return the list of trackers for this torrent. The\n announce entry contains both a string url which specify the\n announce url for the tracker as well as an int tier, which is\n specifies the order in which this tracker is tried. If you want\n libtorrent to use another list of trackers for this torrent, you can\n@@ -7471,36 +7471,36 @@\n data will replace the original ones.
\n \n \n [report issue]\n-std::set<std::string> url_seeds () const;\n void remove_url_seed (std::string const& url) const;\n void add_url_seed (std::string const& url) const;\n+std::set<std::string> url_seeds () const;\n\n
add_url_seed() adds another url to the torrent's list of url\n seeds. If the given url already exists in that list, the call has no\n effect. The torrent will connect to the server and try to download\n pieces from it, unless it's paused, queued, checking or seeding.\n remove_url_seed() removes the given url if it exists already.\n url_seeds() return a set of the url seeds currently in this\n torrent. Note that URLs that fails may be removed automatically from\n the list.
\nSee http seeding for more information.
\n-\n \n-[report issue]\n-void remove_http_seed (std::string const& url) const;\n std::set<std::string> http_seeds () const;\n void add_http_seed (std::string const& url) const;\n+void remove_http_seed (std::string const& url) const;\n\n
These functions are identical as the *_url_seed() variants, but\n they operate on BEP 17 web seeds instead of BEP 19.
\nSee http seeding for more information.
\n [report issue]Clients should only use is_valid() to determine if the result of\n session::find_torrent() was successful.
\nUnlike other member functions which return a value, is_valid()\n completes immediately, without blocking on a result from the\n network thread. Also unlike other functions, it never throws\n the system_error exception.
\n-\n-[report issue]\n-void pause (pause_flags_t flags = {}) const;\n void resume () const;\n+void pause (pause_flags_t flags = {}) const;\n \n pause(), and resume() will disconnect all peers and reconnect\n all peers respectively. When a torrent is paused, it will however\n remember all share ratios to all peers and remember all potential (not\n connected) peers. Torrents may be paused automatically if there is a\n file error (e.g. disk full) or something similar. See\n file_error_alert.
\n@@ -7567,24 +7567,24 @@\nNote
\nTorrents that are auto-managed may be automatically resumed again. It\n does not make sense to pause an auto-managed torrent without making it\n not auto-managed first. Torrents are auto-managed by default when added\n to the session. For more information, see queuing.
\n\n void set_flags (torrent_flags_t flags, torrent_flags_t mask) const;\n-torrent_flags_t flags () const;\n-void set_flags (torrent_flags_t flags) const;\n void unset_flags (torrent_flags_t flags) const;\n+void set_flags (torrent_flags_t flags) const;\n+torrent_flags_t flags () const;\n\n
sets and gets the torrent state flags. See torrent_flags_t.\n The set_flags overload that take a mask will affect all\n flags part of the mask, and set their values to what the\n flags argument is set to. This allows clearing and\n setting flags in a single function call.\n The set_flags overload that just takes flags, sets all\n@@ -7735,27 +7735,27 @@\n
Note
\nA torrent's resume data is considered saved as soon as the\n save_resume_data_alert is posted. It is important to make sure this\n alert is received and handled in order for this function to be\n meaningful.
\n\n-queue_position_t queue_position () const;\n void queue_position_down () const;\n+void queue_position_bottom () const;\n void queue_position_top () const;\n void queue_position_up () const;\n-void queue_position_bottom () const;\n+queue_position_t queue_position () const;\n\n
Every torrent that is added is assigned a queue position exactly one\n greater than the greatest queue position of all existing torrents.\n Torrents that are being seeded have -1 as their queue position, since\n they're no longer in line to be downloaded.
\nWhen a torrent is removed or turns into a seed, all torrents with\n greater queue positions have their positions decreased to fill in the\n@@ -7779,21 +7779,21 @@\n of all other torrents remain intact but their numerical queue position\n shifts to make space for this torrent's new position
\n \n [report issue]\n-void set_ssl_certificate_buffer (std::string const& certificate\n- , std::string const& private_key\n- , std::string const& dh_params);\n void set_ssl_certificate (std::string const& certificate\n , std::string const& private_key\n , std::string const& dh_params\n , std::string const& passphrase = "");\n+void set_ssl_certificate_buffer (std::string const& certificate\n+ , std::string const& private_key\n+ , std::string const& dh_params);\n\n
For SSL torrents, use this to specify a path to a .pem file to use as\n this client's certificate. The certificate must be signed by the\n certificate in the .torrent file to be valid.
\nThe set_ssl_certificate_buffer() overload takes the actual certificate,\n private key and DH params as strings, rather than paths to files.
\ncert is a path to the (signed) certificate in .pem format\n@@ -7809,18 +7809,18 @@\n
Note that when a torrent first starts up, and it needs a certificate,\n it will suspend connecting to any peers until it has one. It's\n typically desirable to resume the torrent after setting the SSL\n certificate.
\nIf you receive a torrent_need_cert_alert, you need to call this to\n provide a valid cert. If you don't have a cert you won't be allowed to\n connect to any peers.
\n-\n-[report issue]\n std::shared_ptr<torrent_info> torrent_file_with_hashes () const;\n std::shared_ptr<const torrent_info> torrent_file () const;\n\n
torrent_file() returns a pointer to the torrent_info object\n associated with this torrent. The torrent_info object may be a copy\n of the internal object. If the torrent doesn't have metadata, the\n@@ -7868,25 +7868,25 @@\n
Fills the specified std::vector<int> with the availability for\n each piece in this torrent. libtorrent does not keep track of\n availability for seeds, so if the torrent is seeding the availability\n for all pieces is reported as 0.
\nThe piece availability is the number of peers that we are connected\n that has advertised having a particular piece. This is the information\n that libtorrent uses in order to prefer picking rare pieces.
\n-\n \n-[report issue]\n std::vector<download_priority_t> get_piece_priorities () const;\n void piece_priority (piece_index_t index, download_priority_t priority) const;\n void prioritize_pieces (std::vector<std::pair<piece_index_t, download_priority_t>> const& pieces) const;\n-download_priority_t piece_priority (piece_index_t index) const;\n void prioritize_pieces (std::vector<download_priority_t> const& pieces) const;\n+download_priority_t piece_priority (piece_index_t index) const;\n\n
These functions are used to set and get the priority of individual\n pieces. By default all pieces have priority 4. That means that the\n random rarest first algorithm is effectively active for all pieces.\n You may however change the priority of individual pieces. There are 8\n priority levels. 0 means not to download the piece at all. Otherwise,\n lower priority values means less likely to be picked. Piece priority\n@@ -7908,24 +7908,24 @@\n Invalid entries, where the piece index or priority is out of range, are\n not allowed.
\nget_piece_priorities returns a vector with one element for each piece\n in the torrent. Each element is the current priority of that piece.
\nIt's possible to cancel the effect of file priorities by setting the\n priorities for the affected pieces. Care has to be taken when mixing\n usage of file- and piece priorities.
\n-\n+\n \n-[report issue]\n-void file_priority (file_index_t index, download_priority_t priority) const;\n download_priority_t file_priority (file_index_t index) const;\n-std::vector<download_priority_t> get_file_priorities () const;\n void prioritize_files (std::vector<download_priority_t> const& files) const;\n+std::vector<download_priority_t> get_file_priorities () const;\n+void file_priority (file_index_t index, download_priority_t priority) const;\n\n
index must be in the range [0, number_of_files).
\nfile_priority() queries or sets the priority of file index.
\nprioritize_files() takes a vector that has at as many elements as\n there are files in the torrent. Each entry is the priority of that\n file. The function sets the priorities of all the pieces in the\n torrent based on the vector.
\n@@ -7948,22 +7948,22 @@\n file_prio_alert.\nWhen combining file- and piece priorities, the resume file will record\n both. When loading the resume data, the file priorities will be applied\n first, then the piece priorities.
\nMoving data from a file into the part file is currently not\n supported. If a file has its priority set to 0 after it has already\n been created, it will not be moved into the partfile.
\n+\n \n-\n-[report issue]\n-void force_lsd_announce () const;\n void force_reannounce (int seconds = 0, int idx = -1, reannounce_flags_t = {}) const;\n+void force_lsd_announce () const;\n void force_dht_announce () const;\n \n force_reannounce() will force this torrent to do another tracker\n request, to receive new peers. The seconds argument specifies how\n many seconds from now to issue the tracker announces.
\nIf the tracker's min_interval has not passed since the last\n announce, the forced announce will be scheduled to happen immediately\n@@ -7988,24 +7988,24 @@\n idx is >= 0, the tracker with the specified index will scraped.
\nA scrape request queries the tracker for statistics such as total\n number of incomplete peers, complete peers, number of downloads etc.
\nThis request will specifically update the num_complete and\n num_incomplete fields in the torrent_status struct once it\n completes. When it completes, it will generate a scrape_reply_alert.\n If it fails, it will generate a scrape_failed_alert.
\n-\n-\n+\n \n-[report issue]\n+int upload_limit () const;\n void set_download_limit (int limit) const;\n int download_limit () const;\n-int upload_limit () const;\n void set_upload_limit (int limit) const;\n\n
set_upload_limit will limit the upload bandwidth used by this\n particular torrent to the limit you set. It is given as the number of\n bytes per second the torrent is allowed to upload.\n set_download_limit works the same way but for download bandwidth\n instead of upload bandwidth. Note that setting a higher limit on a\n@@ -8057,16 +8057,16 @@\n settings_pack.
\nmax_uploads() returns the current settings.
\n \n [report issue]\n-int max_connections () const;\n void set_max_connections (int max_connections) const;\n+int max_connections () const;\n\n
set_max_connections() sets the maximum number of connection this\n torrent will open. If all connections are used up, incoming\n connections may be refused or poor connections may be closed. This\n must be at least 2. The default is unlimited number of connections. If\n -1 is given to the function, it means unlimited. There is also a\n global limit of the number of connections, set by\n@@ -8129,36 +8129,36 @@\n
\n void rename_file (file_index_t index, std::string const& new_name) const;\n\n
Renames the file with the given index asynchronously. The rename\n operation is complete when either a file_renamed_alert or\n file_rename_failed_alert is posted.
\n-\n-[report issue]\n-sha1_hash info_hash () const;\n info_hash_t info_hashes () const;\n+sha1_hash info_hash () const;\n\n
returns the info-hash(es) of the torrent. If this handle is to a\n torrent that hasn't loaded yet (for instance by being added) by a\n URL, the returned value is undefined.\n The info_hash() returns the SHA-1 info-hash for v1 torrents and a\n truncated hash for v2 torrents. For the full v2 info-hash, use\n info_hashes() instead.
\n \n-\n-[report issue]\n-bool operator!= (const torrent_handle& h) const;\n bool operator< (const torrent_handle& h) const;\n+bool operator!= (const torrent_handle& h) const;\n bool operator== (const torrent_handle& h) const;\n\n
comparison operators. The order of the torrents is unspecified\n but stable.
\n [report issue]\n virtual void remove_torrent (storage_index_t) = 0;\n\n
remove the storage with the specified index. This is not expected to\n delete any files from disk, just to clean up any resources associated\n with the specified storage.
\n-\n-[report issue]\n virtual void async_read (storage_index_t storage, peer_request const& r\n , std::function<void(disk_buffer_holder, storage_error const&)> handler\n , disk_job_flags_t flags = {}) = 0;\n virtual bool async_write (storage_index_t storage, peer_request const& r\n , char const* buf, std::shared_ptr<disk_observer> o\n , std::function<void(storage_error const&)> handler\n@@ -8703,22 +8703,22 @@\n internal libtorrent torrent object to tie the storage object allocated\n for a torrent to the lifetime of the internal torrent object. When a\n torrent is removed from the session, this holder is destructed and will\n inform the disk object.\n \n struct storage_holder\n {\n- ~storage_holder ();\n- storage_holder () = default;\n storage_holder (storage_index_t idx, disk_interface& disk_io);\n+ storage_holder () = default;\n+ ~storage_holder ();\n explicit operator bool () const;\n operator storage_index_t () const;\n void reset ();\n- storage_holder (storage_holder const&) = delete;\n storage_holder& operator= (storage_holder const&) = delete;\n+ storage_holder (storage_holder const&) = delete;\n storage_holder (storage_holder&& rhs) noexcept;\n storage_holder& operator= (storage_holder&& rhs) noexcept;\n };\n \n [report issue]The disk buffer holder acts like a unique_ptr that frees a disk buffer\n when it's destructed
\nIf this buffer holder is moved-from, default constructed or reset,\n data() will return nullptr.
\n\n struct disk_buffer_holder\n {\n- disk_buffer_holder (disk_buffer_holder&&) noexcept;\n disk_buffer_holder& operator= (disk_buffer_holder&&) & noexcept;\n- disk_buffer_holder& operator= (disk_buffer_holder const&) = delete;\n+ disk_buffer_holder (disk_buffer_holder&&) noexcept;\n disk_buffer_holder (disk_buffer_holder const&) = delete;\n+ disk_buffer_holder& operator= (disk_buffer_holder const&) = delete;\n disk_buffer_holder (buffer_allocator_interface& alloc\n , char* buf, int sz) noexcept;\n disk_buffer_holder () noexcept = default;\n ~disk_buffer_holder ();\n char* data () const noexcept;\n void reset ();\n void swap (disk_buffer_holder& h) noexcept;\n@@ -8844,18 +8844,18 @@\n settings_interface
\n Declared in "libtorrent/settings_pack.hpp"
\n the common interface to settings_pack and the internal representation of\n settings.
\n \n struct settings_interface\n {\n- virtual bool has_val (int name) const = 0;\n- virtual void set_str (int name, std::string val) = 0;\n virtual void set_bool (int name, bool val) = 0;\n+ virtual void set_str (int name, std::string val) = 0;\n virtual void set_int (int name, int val) = 0;\n+ virtual bool has_val (int name) const = 0;\n virtual std::string const& get_str (int name) const = 0;\n virtual int get_int (int name) const = 0;\n virtual bool get_bool (int name) const = 0;\n };\n \n [report issue]\n struct storage_moved_alert final : torrent_alert\n {\n std::string message () const override;\n- char const* old_path () const;\n char const* storage_path () const;\n+ char const* old_path () const;\n \n static constexpr alert_category_t static_category = alert_category::storage;\n };\n \n-\n-[report issue]\n-char const* old_path () const;\n char const* storage_path () const;\n+char const* old_path () const;\n\n
the path the torrent was moved to and from, respectively.
\n [report issue]Declared in "libtorrent/alert_types.hpp"
\n@@ -11618,17 +11618,17 @@\n std::vector<std::pair<sha1_hash, udp::endpoint>> nodes () const;\n int num_nodes () const;\n \n static constexpr alert_category_t static_category = alert_category::dht;\n sha1_hash node_id;\n };\n \n-\n-[report issue]\n std::vector<std::pair<sha1_hash, udp::endpoint>> nodes () const;\n int num_nodes () const;\n\n
the number of nodes in the routing table and the actual nodes.
\n [report issue]\n std::vector<sha1_hash> samples () const;\n int num_samples () const;\n\n
returns the number of info-hashes returned by the node, as well as the\n actual info-hashes. num_samples() is more efficient than\n samples().size().
\n@@ -11746,16 +11746,16 @@\nthis alert is posted to indicate to the client that some alerts were\n dropped. Dropped meaning that the alert failed to be delivered to the\n client. The most common cause of such failure is that the internal alert\n queue grew too big (controlled by alert_queue_size).
\n\n struct alerts_dropped_alert final : alert\n {\n- static_assert (num_alert_types <= abi_alert_count, "need to increase bitset. This is an ABI break");\n std::string message () const override;\n+ static_assert (num_alert_types <= abi_alert_count, "need to increase bitset. This is an ABI break");\n \n static constexpr alert_category_t static_category = alert_category::error;\n std::bitset<abi_alert_count> dropped_alerts;\n };\n \n [report issue]Declared in "libtorrent/alert.hpp"
\n\n-template <typename T> T const* alert_cast (alert const* a);\n template <typename T> T* alert_cast (alert* a);\n+template <typename T> T const* alert_cast (alert const* a);\n\n
When you get an alert, you can use alert_cast<> to attempt to cast the\n pointer to a specific alert type, in order to query it for more\n information.
\nNote
\nalert_cast<> can only cast to an exact alert type, not a base class
\n@@ -12361,20 +12361,20 @@\n a single rule that allows all addresses (0.0.0.0 - 255.255.255.255 for\n the IPv4 range, and the equivalent range covering all addresses for the\n IPv6 range).\nA default constructed ip_filter does not filter any address.
\n\n struct ip_filter\n {\n- ~ip_filter ();\n- ip_filter& operator= (ip_filter const&);\n ip_filter ();\n- ip_filter (ip_filter&&);\n- ip_filter& operator= (ip_filter&&);\n+ ip_filter& operator= (ip_filter const&);\n ip_filter (ip_filter const&);\n+ ip_filter& operator= (ip_filter&&);\n+ ip_filter (ip_filter&&);\n+ ~ip_filter ();\n bool empty () const;\n void add_rule (address const& first, address const& last, std::uint32_t flags);\n std::uint32_t access (address const& addr) const;\n filter_tuple_t export_filter () const;\n \n enum access_flags\n {\n@@ -12458,20 +12458,20 @@\n the port filter maps non-overlapping port ranges to flags. This\n is primarily used to indicate whether a range of ports should\n be connected to or not. The default is to have the full port\n range (0-65535) set to flag 0.
\n \n class port_filter\n {\n+ port_filter& operator= (port_filter const&);\n+ port_filter (port_filter&&);\n+ port_filter (port_filter const&);\n ~port_filter ();\n- port_filter ();\n port_filter& operator= (port_filter&&);\n- port_filter (port_filter const&);\n- port_filter (port_filter&&);\n- port_filter& operator= (port_filter const&);\n+ port_filter ();\n void add_rule (std::uint16_t first, std::uint16_t last, std::uint32_t flags);\n std::uint32_t access (std::uint16_t port) const;\n \n enum access_flags\n {\n blocked,\n };\n@@ -12547,38 +12547,38 @@\n entry (preformatted_type);\n entry (dictionary_type);\n entry (list_type);\n entry (integer_type);\n entry (U v);\n entry (data_type t);\n entry (bdecode_node const& n);\n- entry& operator= (entry const&) &;\n- entry& operator= (dictionary_type) &;\n- entry& operator= (bdecode_node const&) &;\n- entry& operator= (list_type) &;\n- entry& operator= (preformatted_type) &;\n entry& operator= (entry&&) & noexcept;\n+ entry& operator= (bdecode_node const&) &;\n entry& operator= (integer_type) &;\n+ entry& operator= (preformatted_type) &;\n entry& operator= (span<char const>) &;\n+ entry& operator= (dictionary_type) &;\n+ entry& operator= (list_type) &;\n+ entry& operator= (entry const&) &;\n entry& operator= (U v) &;\n- dictionary_type const& dict () const;\n+ preformatted_type const& preformatted () const;\n+ list_type const& list () const;\n integer_type const& integer () const;\n- string_type& string ();\n- list_type& list ();\n preformatted_type& preformatted ();\n- string_type const& string () const;\n dictionary_type& dict ();\n+ dictionary_type const& dict () const;\n+ string_type const& string () const;\n integer_type& integer ();\n- preformatted_type const& preformatted () const;\n- list_type const& list () const;\n+ string_type& string ();\n+ list_type& list ();\n void swap (entry& e);\n entry const& operator[] (string_view key) const;\n entry& operator[] (string_view key);\n- entry* find_key (string_view key);\n entry const* find_key (string_view key) const;\n+ entry* find_key (string_view key);\n std::string to_string (bool single_line = false) const;\n \n enum data_type\n {\n int_t,\n string_t,\n list_t,\n@@ -12622,43 +12622,43 @@\n entry (bdecode_node const& n);\n \n construct from bdecode_node parsed form (see bdecode())
\n [report issue]\n-entry& operator= (entry const&) &;\n-entry& operator= (dictionary_type) &;\n-entry& operator= (bdecode_node const&) &;\n-entry& operator= (list_type) &;\n-entry& operator= (preformatted_type) &;\n entry& operator= (entry&&) & noexcept;\n+entry& operator= (bdecode_node const&) &;\n entry& operator= (integer_type) &;\n+entry& operator= (preformatted_type) &;\n entry& operator= (span<char const>) &;\n+entry& operator= (dictionary_type) &;\n+entry& operator= (list_type) &;\n+entry& operator= (entry const&) &;\n\n
copies the structure of the right hand side into this\n entry.
\n-\n-\n \n+\n \n-[report issue]\n-dictionary_type const& dict () const;\n+preformatted_type const& preformatted () const;\n+list_type const& list () const;\n integer_type const& integer () const;\n-string_type& string ();\n-list_type& list ();\n preformatted_type& preformatted ();\n-string_type const& string () const;\n dictionary_type& dict ();\n+dictionary_type const& dict () const;\n+string_type const& string () const;\n integer_type& integer ();\n-preformatted_type const& preformatted () const;\n-list_type const& list () const;\n+string_type& string ();\n+list_type& list ();\n\n
The integer(), string(), list() and dict() functions\n are accessors that return the respective type. If the entry object\n isn't of the type you request, the accessor will throw\n system_error. You can ask an entry for its type through the\n type() function.
\nIf you want to create an entry you give it the type you want it to\n@@ -12718,16 +12718,16 @@\n
The const version of operator[] will only return a reference to an\n existing element at the given key. If the key is not found, it will\n throw system_error.
\n [report issue]\n-entry* find_key (string_view key);\n entry const* find_key (string_view key) const;\n+entry* find_key (string_view key);\n\n
These functions requires the entry to be a dictionary, if it isn't\n they will throw system_error.
\nThey will look for an element at the given key in the dictionary, if\n the element cannot be found, they will return nullptr. If an element\n with the given key is found, the return a pointer to it.
\n [report issue]\n struct create_torrent\n {\n explicit create_torrent (torrent_info const& ti);\n explicit create_torrent (file_storage& fs, int piece_size = 0\n , create_flags_t flags = {});\n- std::vector<char> generate_buf () const;\n entry generate () const;\n+ std::vector<char> generate_buf () const;\n file_storage const& files () const;\n void set_comment (char const* str);\n void set_creator (char const* str);\n void set_creation_date (std::time_t timestamp);\n void set_hash (piece_index_t index, sha1_hash const& h);\n void set_hash2 (file_index_t file, piece_index_t::diff_type piece, sha256_hash const& h);\n void add_http_seed (string_view url);\n void add_url_seed (string_view url);\n void add_node (std::pair<std::string, int> node);\n void add_tracker (string_view url, int tier = 0);\n void set_root_cert (string_view cert);\n- void set_priv (bool p);\n bool priv () const;\n- bool is_v2_only () const;\n+ void set_priv (bool p);\n bool is_v1_only () const;\n+ bool is_v2_only () const;\n int num_pieces () const;\n piece_index_t end_piece () const;\n index_range<piece_index_t> piece_range () const noexcept;\n file_index_t end_file () const;\n index_range<file_index_t> file_range () const noexcept;\n index_range<piece_index_t::diff_type> file_piece_range (file_index_t f);\n std::int64_t total_size () const;\n int piece_length () const;\n int piece_size (piece_index_t i) const;\n- void add_similar_torrent (sha1_hash ih);\n void add_collection (string_view c);\n+ void add_similar_torrent (sha1_hash ih);\n \n static constexpr create_flags_t modification_time = 2_bit;\n static constexpr create_flags_t symlinks = 3_bit;\n static constexpr create_flags_t v2_only = 5_bit;\n static constexpr create_flags_t v1_only = 6_bit;\n static constexpr create_flags_t canonical_files = 7_bit;\n static constexpr create_flags_t no_attributes = 8_bit;\n@@ -12930,16 +12930,16 @@\n entire duration of the create_torrent object.\n \n-std::vector<char> generate_buf () const;\n entry generate () const;\n+std::vector<char> generate_buf () const;\n\n
This function will generate the .torrent file as a bencode tree, or a\n bencoded into a buffer.\n In order to encode the entry into a flat file, use the bencode() function.
\nThe function returning an entry may be useful to add custom entries\n to the torrent file before bencoding it and saving it to disk.
\nWhether the resulting torrent object is v1, v2 or hybrid depends on\n@@ -13022,18 +13022,18 @@\n 16 kiB blocks. Note that piece sizes must be powers-of-2, so all\n per-piece merkle trees are complete.\n A SHA-256 hash of all zeros is internally used to indicate a hash\n that has not been set. Setting such hash will not be considered set\n when calling generate().\n This function will throw std::system_error if it is called on an\n object constructed with the v1_only flag.
\n-\n-[report issue]\n void add_http_seed (string_view url);\n void add_url_seed (string_view url);\n\n
This adds a url seed to the torrent. You can have any number of url seeds. For a\n single file torrent, this should be an HTTP url, pointing to a file with identical\n content as the file of the torrent. For a multi-file torrent, it should point to\n@@ -13070,21 +13070,21 @@\n \n
This function sets an X.509 certificate in PEM format to the torrent. This makes the\n torrent an SSL torrent. An SSL torrent requires that each peer has a valid certificate\n signed by this root certificate. For SSL torrents, all peers are connecting over SSL\n connections. For more information, see the section on ssl torrents.
\nThe string is not the path to the cert, it's the actual content of the\n certificate.
\n-\n-[report issue]\n-void set_priv (bool p);\n bool priv () const;\n+void set_priv (bool p);\n\n
Sets and queries the private flag of the torrent.\n Torrents with the private flag set ask the client to not use any other\n sources than the tracker for peers, and to not use DHT to advertise itself publicly,\n only the tracker.
\n [report issue]\n std::int64_t total_size () const;\n\n
the total number of bytes of all files and pad files
\n-\n-[report issue]\n int piece_length () const;\n int piece_size (piece_index_t i) const;\n\n
piece_length() returns the piece size of all pieces but the\n last one. piece_size() returns the size of the specified piece.\n these functions are just forwarding to the associated file_storage.
\n \n [report issue]\n-void add_similar_torrent (sha1_hash ih);\n void add_collection (string_view c);\n+void add_similar_torrent (sha1_hash ih);\n\n
Add similar torrents (by info-hash) or collections of similar torrents.\n Similar torrents are expected to share some files with this torrent.\n Torrents sharing a collection name with this torrent are also expected\n to share files with this torrent. A torrent may have more than one\n collection and more than one similar torrents. For more information,\n see BEP 38.
\n@@ -13209,17 +13209,17 @@\n [report issue]Declared in "libtorrent/create_torrent.hpp"
\n\n void add_files (file_storage& fs, std::string const& file\n- , create_flags_t flags = {});\n-void add_files (file_storage& fs, std::string const& file\n , std::function<bool(std::string)> p, create_flags_t flags = {});\n+void add_files (file_storage& fs, std::string const& file\n+ , create_flags_t flags = {});\n \n Adds the file specified by path to the file_storage object. In case path\n refers to a directory, files will be added recursively from the directory.
\nIf specified, the predicate p is called once for every file and directory that\n is encountered. Files for which p returns true are added, and directories for\n which p returns true are traversed. p must have the following signature:
\n\n@@ -13232,29 +13232,29 @@\nThe flags argument should be the same as the flags passed to the create_torrent\n constructor.
\n [report issue]
Declared in "libtorrent/create_torrent.hpp"
\n\n-inline void set_piece_hashes (create_torrent& t, std::string const& p\n- , std::function<void(piece_index_t)> const& f);\n void set_piece_hashes (create_torrent& t, std::string const& p\n , settings_interface const& settings\n , std::function<void(piece_index_t)> const& f, error_code& ec);\n+inline void set_piece_hashes (create_torrent& t, std::string const& p);\n void set_piece_hashes (create_torrent& t, std::string const& p\n , std::function<void(piece_index_t)> const& f, error_code& ec);\n-void set_piece_hashes (create_torrent& t, std::string const& p\n- , settings_interface const& settings, disk_io_constructor_type disk_io\n- , std::function<void(piece_index_t)> const& f, error_code& ec);\n inline void set_piece_hashes (create_torrent& t, std::string const& p\n- , settings_interface const& settings\n , std::function<void(piece_index_t)> const& f);\n-inline void set_piece_hashes (create_torrent& t, std::string const& p);\n inline void set_piece_hashes (create_torrent& t, std::string const& p, error_code& ec);\n+inline void set_piece_hashes (create_torrent& t, std::string const& p\n+ , settings_interface const& settings\n+ , std::function<void(piece_index_t)> const& f);\n+void set_piece_hashes (create_torrent& t, std::string const& p\n+ , settings_interface const& settings, disk_io_constructor_type disk_io\n+ , std::function<void(piece_index_t)> const& f, error_code& ec);\n\n
This function will assume that the files added to the torrent file exists at path\n p, read those files and hash the content and set the hashes in the create_torrent\n object. The optional function f is called in between every hash that is set. f\n must have the following signature:
\n