diff --git a/docs/building.html b/docs/building.html index cc1182614..4cb6dc50a 100644 --- a/docs/building.html +++ b/docs/building.html @@ -22,12 +22,13 @@

Table of contents

+

building from cvs

+

To build libtorrent from cvs you need to check out the libtorrent sources from +sourceforge and also check out the asio sources from its sourceforge cvs. +If you downloaded a release tarball, you can skip this section.

+

To prepare the directory structure for building, follow these steps:

+ +

Now the libtorrent directory is ready for building. Follow the steps in one +of the following sections depending on which build system you prefer to use.

+
+

building with BBv2

The primary reason to use boost-build is that it will automatically build the dependent boost libraries with the correct compiler settings, in order to @@ -346,7 +363,7 @@ with the following option:

The above option make use of -DNDEBUG, which is used throughout libtorrent.

-

Step 3: Building libtorrent

+

Step 3: Building libtorrent

Once the configure script is run successfully, you just type make and libtorrent, the examples and the tests will be built.

When libtorrent is built it may be a good idea to run the tests, you do this diff --git a/docs/building.rst b/docs/building.rst index fa2fde018..9fb22ffe9 100644 --- a/docs/building.rst +++ b/docs/building.rst @@ -36,6 +36,27 @@ These tutorials may work on similar linux distros as well. .. _suse: suse_build_notes.html .. _`visual studio 2005`: vs2005_build_notes.html +building from cvs +----------------- + +To build libtorrent from cvs you need to check out the libtorrent sources from +sourceforge and also check out the asio sources from its sourceforge cvs. +If you downloaded a release tarball, you can skip this section. + +To prepare the directory structure for building, follow these steps: + +* Check out libtorrent (instructions__). +* Check out asio (instructions__). +* Copy the ``asio/include/asio/`` directory into the ``libtorrent/include/libtorrent/`` + directory. Alternatively you can make a symbolic link. +* Copy ``asio/include/asio.hpp`` into ``libtorrent/include/libtorrent``. + +__ http://sourceforge.net/cvs/?group_id=79942 +__ http://sourceforge.net/cvs/?group_id=122478 + +Now the libtorrent directory is ready for building. Follow the steps in one +of the following sections depending on which build system you prefer to use. + building with BBv2 ------------------ @@ -384,7 +405,6 @@ on how to build libtorrent with VS 2005, see `this document`_. .. _`this document`: vs2005_build_notes.html - build configurations -------------------- diff --git a/docs/manual.html b/docs/manual.html index 962c91200..4ca39318d 100755 --- a/docs/manual.html +++ b/docs/manual.html @@ -32,134 +32,135 @@

  • abort()
  • add_torrent()
  • remove_torrent() find_torrent() get_torrents()
    • -
  • set_upload_rate_limit() set_download_rate_limit()
    • +
  • set_upload_rate_limit() set_download_rate_limit() upload_rate_limit() download_rate_limit()
  • set_max_uploads() set_max_connections()
    • -
  • set_max_half_open_connections()
    • -
  • set_ip_filter()
    • -
  • status()
    • -
  • is_listening() listen_port() listen_on()
    • -
  • pop_alert() set_severity_level()
    • -
  • add_extension()
    • -
  • start_dht() stop_dht() set_dht_settings() dht_state()
    • -
  • add_dht_node() add_dht_router()
    • +
  • num_uploads() num_connections()
    • +
  • set_max_half_open_connections()
    • +
  • set_ip_filter()
    • +
  • status()
    • +
  • is_listening() listen_port() listen_on()
    • +
  • pop_alert() set_severity_level()
    • +
  • add_extension()
    • +
  • start_dht() stop_dht() set_dht_settings() dht_state()
    • +
  • add_dht_node() add_dht_router()
    • -
  • entry
    • @@ -251,11 +252,16 @@ class session: public boost::noncopyable session_settings const& settings); void set_upload_rate_limit(int bytes_per_second); + int upload_rate_limit() const; void set_download_rate_limit(int bytes_per_second); + int download_rate_limit() const; void set_max_uploads(int limit); void set_max_connections(int limit); void set_max_half_open_connections(int limit); + int num_uploads() const; + int num_connections() const; + void set_ip_filter(ip_filter const& f); session_status status() const; @@ -406,18 +412,22 @@ In case the torrent cannot be found, an invalid torrent_handle is returned.

    currently in the session.

    -

    set_upload_rate_limit() set_download_rate_limit()

    +

    set_upload_rate_limit() set_download_rate_limit() upload_rate_limit() download_rate_limit()

     void set_upload_rate_limit(int bytes_per_second);
 void set_download_rate_limit(int bytes_per_second);
+int upload_rate_limit() const;
+int download_rate_limit() const;

    set_upload_rate_limit() set the maximum number of bytes allowed to be sent to peers per second. This bandwidth is distributed among all the peers. If you don't want to limit upload rate, you can set this to -1 (the default). set_download_rate_limit() works the same way but for download rate instead -of upload rate.

    +of upload rate. +download_rate_limit() and upload_rate_limit() returns the previously +set limits.

    set_max_uploads() set_max_connections()

    @@ -434,6 +444,17 @@ connections limit, and open too many torrents, the limit will not be met. The number of uploads is at least one per torrent.

    +

    num_uploads() num_connections()

    +
    +
    +int num_uploads() const;
+int num_connections() const;
+
    +
    +

    Returns the number of currently unchoked peers and the number of connections +(including half-open ones) respectively.

    +
    +

    set_max_half_open_connections()

    @@ -579,6 +600,11 @@ info-hash.
 or <libtorrent/extensions/ut_pex.hpp>. The functions to pass in to
 add_extension() are libtorrent::create_metadata_plugin and
 libtorrent::create_ut_pex_plugin respectively.
    
+
    e.g.
    
+
    +ses.add_extension(&libtorrent::create_metadata_plugin);
+ses.add_extension(&libtorrent::create_ut_pex_plugin);
+

    start_dht() stop_dht() set_dht_settings() dht_state()

    diff --git a/docs/manual.rst b/docs/manual.rst index 863610a10..75b05138e 100755 --- a/docs/manual.rst +++ b/docs/manual.rst @@ -96,11 +96,16 @@ The ``session`` class has the following synopsis:: session_settings const& settings); void set_upload_rate_limit(int bytes_per_second); + int upload_rate_limit() const; void set_download_rate_limit(int bytes_per_second); + int download_rate_limit() const; void set_max_uploads(int limit); void set_max_connections(int limit); void set_max_half_open_connections(int limit); + int num_uploads() const; + int num_connections() const; + void set_ip_filter(ip_filter const& f); session_status status() const; @@ -264,19 +269,23 @@ See ``torrent_handle::is_valid()`` to know if the torrent was found or not. currently in the session. -set_upload_rate_limit() set_download_rate_limit() -------------------------------------------------- +set_upload_rate_limit() set_download_rate_limit() upload_rate_limit() download_rate_limit() +------------------------------------------------------------------------------------------- :: void set_upload_rate_limit(int bytes_per_second); void set_download_rate_limit(int bytes_per_second); + int upload_rate_limit() const; + int download_rate_limit() const; ``set_upload_rate_limit()`` set the maximum number of bytes allowed to be sent to peers per second. This bandwidth is distributed among all the peers. If you don't want to limit upload rate, you can set this to -1 (the default). ``set_download_rate_limit()`` works the same way but for download rate instead of upload rate. +``download_rate_limit()`` and ``upload_rate_limit()`` returns the previously +set limits. set_max_uploads() set_max_connections() @@ -294,6 +303,18 @@ connections limit, and open too many torrents, the limit will not be met. The number of uploads is at least one per torrent. +num_uploads() num_connections() +------------------------------- + + :: + + int num_uploads() const; + int num_connections() const; + +Returns the number of currently unchoked peers and the number of connections +(including half-open ones) respectively. + + set_max_half_open_connections() ------------------------------- @@ -455,6 +476,13 @@ or ````. The functions to pass in to ``add_extension()`` are ``libtorrent::create_metadata_plugin`` and ``libtorrent::create_ut_pex_plugin`` respectively. +e.g. + +:: + + ses.add_extension(&libtorrent::create_metadata_plugin); + ses.add_extension(&libtorrent::create_ut_pex_plugin); + .. _`libtorrent plugins`: libtorrent_plugins.html start_dht() stop_dht() set_dht_settings() dht_state()