jiigen666/libtorrent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
Arvid Norberg
2005-07-10 10:42:00 +00:00
parent c094bc98b5
commit 080da58903
10 changed files with 164 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/manual.rst
View File

@@ -226,14 +226,16 @@ The ``session`` class has the following synopsis::
entry const& e
, boost::filesystem::path const& save_path
, entry const& resume_data = entry()
, bool compact_mode = true);
, bool compact_mode = true
, int block_size = 16 * 1024);
torrent_handle add_torrent(
char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
, entry const& resume_data = entry()
, bool compact_mode = true);
, bool compact_mode = true
, int block_size = 16 * 1024);
void remove_torrent(torrent_handle const& h);
@@ -303,13 +305,16 @@ add_torrent()
entry const& e
, boost::filesystem::path const& save_path
, entry const& resume_data = entry()
, bool compact_mode = true);
, bool compact_mode = true
, int block_size = 16 * 1024);
torrent_handle add_torrent(
char const* tracker_url
, sha1_hash const& info_hash
, boost::filesystem::path const& save_path
, entry const& resume_data = entry()
, bool compact_mode = true);
, bool compact_mode = true
, int block_size = 16 * 1024);
You add torrents through the ``add_torrent()`` function where you give an
object representing the information found in the torrent file and the path where you
@@ -331,6 +336,11 @@ downloaded. If it is false, the entire storage is allocated before download begi
the files contained in the torrent are filled with zeroes, and each downloaded piece
is put in its final place directly when downloaded.
``block_size`` sets the preferred request size, i.e. the number of bytes to request from
a peer at a time. This block size must be a divisor of the piece size, and since the piece
size is an even power of 2, so must the block size be. If the block size given here turns
out to be greater than the piece size, it will simply be clamped to the piece size.
The torrent_handle_ returned by ``add_torrent()`` can be used to retrieve information
about the torrent's progress, its peers etc. It is also used to abort a torrent.