diff --git a/docs/reference-Session.html b/docs/reference-Session.html index c2143c240..81db3e696 100644 --- a/docs/reference-Session.html +++ b/docs/reference-Session.html @@ -591,8 +591,9 @@ class session: public boost::noncopyable void set_dht_settings (dht_settings const& settings); void add_dht_router (std::pair<std::string, int> const& node); void add_dht_node (std::pair<std::string, int> const& node); + void add_extension (boost::function<boost::shared_ptr<torrent_plugin>( + torrent*, void*)> ext); void add_extension (boost::shared_ptr<plugin> ext); - void add_extension (boost::function<boost::shared_ptr<torrent_plugin>(torrent*, void*)> ext); void load_country_db (char const* file); void load_asnum_db (char const* file); int as_for_ip (address const& addr); @@ -979,14 +980,16 @@ for bootstrapping, to keep the load off them.

add_extension()

+void add_extension (boost::function<boost::shared_ptr<torrent_plugin>(
+      torrent*, void*)> ext);
 void add_extension (boost::shared_ptr<plugin> ext);
-void add_extension (boost::function<boost::shared_ptr<torrent_plugin>(torrent*, void*)> ext);
-

This function adds an extension to this session. The argument is a function -object that is called with a torrent* and which should return a -boost::shared_ptr<torrent_plugin>. To write custom plugins, see -libtorrent plugins. For the typical bittorrent client all of these -extensions should be added. The main plugins implemented in libtorrent are:

+

This function adds an extension to this session. The argument is a +function object that is called with a torrent* and which should +return a boost::shared_ptr<torrent_plugin>. To write custom +plugins, see libtorrent plugins. For the typical bittorrent client +all of these extensions should be added. The main plugins implemented +in libtorrent are:

metadata extension
Allows peers to download the metadata (.torren files) from the swarm @@ -1033,11 +1036,13 @@ void load_country_db (char const* file); void load_asnum_db (char const* file); int as_for_ip (address const& addr); -

These functions are not available if TORRENT_DISABLE_GEO_IP is defined. They -expects a path to the MaxMind ASN database and MaxMind GeoIP database -respectively. This will be used to look up which AS and country peers belong to.

-

as_for_ip returns the AS number for the IP address specified. If the IP is not -in the database or the ASN database is not loaded, 0 is returned.

+

These functions are not available if TORRENT_DISABLE_GEO_IP is +defined. They expects a path to the MaxMind ASN database and +MaxMind GeoIP database respectively. This will be used to look up +which AS and country peers belong to.

+

as_for_ip returns the AS number for the IP address specified. If +the IP is not in the database or the ASN database is not loaded, 0 is +returned.

@@ -1183,9 +1188,9 @@ void set_settings (session_settings const& s); pe_settings get_pe_settings () const; void set_pe_settings (pe_settings const& settings); -

Sets the session settings and the packet encryption settings respectively. -See session_settings and pe_settings for more information on available -options.

+

Sets the session settings and the packet encryption settings +respectively. See session_settings and pe_settings for more +information on available options.

diff --git a/include/libtorrent/session.hpp b/include/libtorrent/session.hpp index 6d9d33892..d49cacd97 100644 --- a/include/libtorrent/session.hpp +++ b/include/libtorrent/session.hpp @@ -511,11 +511,12 @@ namespace libtorrent void start_dht(entry const& startup_state) TORRENT_DEPRECATED; #endif - // This function adds an extension to this session. The argument is a function - // object that is called with a ``torrent*`` and which should return a - // ``boost::shared_ptr``. To write custom plugins, see - // `libtorrent plugins`_. For the typical bittorrent client all of these - // extensions should be added. The main plugins implemented in libtorrent are: + // This function adds an extension to this session. The argument is a + // function object that is called with a ``torrent*`` and which should + // return a ``boost::shared_ptr``. To write custom + // plugins, see `libtorrent plugins`_. For the typical bittorrent client + // all of these extensions should be added. The main plugins implemented + // in libtorrent are: // // metadata extension // Allows peers to download the metadata (.torren files) from the swarm @@ -555,15 +556,18 @@ namespace libtorrent // // // .. _`libtorrent plugins`: libtorrent_plugins.html - void add_extension(boost::function(torrent*, void*)> ext); + void add_extension(boost::function( + torrent*, void*)> ext); void add_extension(boost::shared_ptr ext); - // These functions are not available if ``TORRENT_DISABLE_GEO_IP`` is defined. They - // expects a path to the `MaxMind ASN database`_ and `MaxMind GeoIP database`_ - // respectively. This will be used to look up which AS and country peers belong to. + // These functions are not available if ``TORRENT_DISABLE_GEO_IP`` is + // defined. They expects a path to the `MaxMind ASN database`_ and + // `MaxMind GeoIP database`_ respectively. This will be used to look up + // which AS and country peers belong to. // - // ``as_for_ip`` returns the AS number for the IP address specified. If the IP is not - // in the database or the ASN database is not loaded, 0 is returned. + // ``as_for_ip`` returns the AS number for the IP address specified. If + // the IP is not in the database or the ASN database is not loaded, 0 is + // returned. // // .. _`MaxMind ASN database`: http://www.maxmind.com/app/asnum // .. _`MaxMind GeoIP database`: http://www.maxmind.com/app/geolitecountry @@ -751,9 +755,9 @@ namespace libtorrent // the torrent is deleted, a torrent_deleted_alert is posted. void remove_torrent(const torrent_handle& h, int options = 0); - // Sets the session settings and the packet encryption settings respectively. - // See session_settings and pe_settings for more information on available - // options. + // Sets the session settings and the packet encryption settings + // respectively. See session_settings and pe_settings for more + // information on available options. void set_settings(session_settings const& s); session_settings settings() const; void set_pe_settings(pe_settings const& settings);