wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

update documentation

This commit is contained in:
arvidn 2016-02-18 20:44:11 -05:00 committed by arvidn
parent 67dbca14b7
commit 8304cb07bc
2 changed files with 3 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/manual.rst
View File

@ -372,30 +372,14 @@ The file format is a bencoded dictionary containing the following fields:
| ``file-format`` | string: "libtorrent resume file" | | ``file-format`` | string: "libtorrent resume file" |
| | | | | |
+--------------------------+--------------------------------------------------------------+ +--------------------------+--------------------------------------------------------------+
| ``file-version`` | integer: 1 |
| | |
+--------------------------+--------------------------------------------------------------+
| ``info-hash`` | string, the info hash of the torrent this data is saved for. | | ``info-hash`` | string, the info hash of the torrent this data is saved for. |
| | | | | |
+--------------------------+--------------------------------------------------------------+ +--------------------------+--------------------------------------------------------------+
| ``blocks per piece`` | integer, the number of blocks per piece. Must be: piece_size |
| | / (16 * 1024). Clamped to be within the range [1, 256]. It |
| | is the number of blocks per (normal sized) piece. Usually |
| | each block is 16 * 1024 bytes in size. But if piece size is |
| | greater than 4 megabytes, the block size will increase. |
| | |
+--------------------------+--------------------------------------------------------------+
| ``pieces`` | A string with piece flags, one character per piece. | | ``pieces`` | A string with piece flags, one character per piece. |
| | Bit 1 means we have that piece. | | | Bit 1 means we have that piece. |
| | Bit 2 means we have verified that this piece is correct. | | | Bit 2 means we have verified that this piece is correct. |
| | This only applies when the torrent is in seed_mode. | | | This only applies when the torrent is in seed_mode. |
+--------------------------+--------------------------------------------------------------+ +--------------------------+--------------------------------------------------------------+
| ``slots`` | list of integers. The list maps slots to piece indices. It |
| | tells which piece is on which slot. If piece index is -2 it |
| | means it is free, that there's no piece there. If it is -1, |
| | means the slot isn't allocated on disk yet. The pieces have |
| | to meet the following requirement: |
+--------------------------+--------------------------------------------------------------+
| ``total_uploaded`` | integer. The number of bytes that have been uploaded in | | ``total_uploaded`` | integer. The number of bytes that have been uploaded in |
| | total for this torrent. | | | total for this torrent. |
+--------------------------+--------------------------------------------------------------+ +--------------------------+--------------------------------------------------------------+
@ -408,14 +392,6 @@ The file format is a bencoded dictionary containing the following fields:
| ``seeding_time`` | integer. The number of seconds this torrent has been active | | ``seeding_time`` | integer. The number of seconds this torrent has been active |
| | and seeding. | | | and seeding. |
+--------------------------+--------------------------------------------------------------+ +--------------------------+--------------------------------------------------------------+
| ``num_seeds`` | integer. An estimate of the number of seeds on this torrent |
| | when the resume data was saved. This is scrape data or based |
| | on the peer list if scrape data is unavailable. |
+--------------------------+--------------------------------------------------------------+
| ``num_downloaders`` | integer. An estimate of the number of downloaders on this |
| | torrent when the resume data was last saved. This is used as |
| | an initial estimate until we acquire up-to-date scrape info. |
+--------------------------+--------------------------------------------------------------+
| ``upload_rate_limit`` | integer. In case this torrent has a per-torrent upload rate | | ``upload_rate_limit`` | integer. In case this torrent has a per-torrent upload rate |
| | limit, this is that limit. In bytes per second. | | | limit, this is that limit. In bytes per second. |
+--------------------------+--------------------------------------------------------------+ +--------------------------+--------------------------------------------------------------+
@ -510,15 +486,6 @@ The file format is a bencoded dictionary containing the following fields:
| | +-------------+--------------------------------------------+ | | | +-------------+--------------------------------------------+ |
| | | | | |
+--------------------------+--------------------------------------------------------------+ +--------------------------+--------------------------------------------------------------+
| ``file sizes`` | list where each entry corresponds to a file in the file list |
| | in the metadata. Each entry has a list of two values, the |
| | first value is the size of the file in bytes, the second |
| | is the time stamp when the last time someone wrote to it. |
| | This information is used to compare with the files on disk. |
| | All the files must match exactly this information in order |
| | to consider the resume data as current. Otherwise a full |
| | re-check is issued. |
+--------------------------+--------------------------------------------------------------+
| ``allocation`` | The allocation mode for the storage. Can be either ``full`` | | ``allocation`` | The allocation mode for the storage. Can be either ``full`` |
| | or ``compact``. If this is full, the file sizes and | | | or ``compact``. If this is full, the file sizes and |
| | timestamps are disregarded. Pieces are assumed not to have | | | timestamps are disregarded. Pieces are assumed not to have |

3
src/read_resume_data.cpp
View File

@ -68,6 +68,8 @@ namespace libtorrent
add_torrent_params read_resume_data(bdecode_node const& rd, error_code& ec) add_torrent_params read_resume_data(bdecode_node const& rd, error_code& ec)
{ {
// TODO: 4 where is "allocation" read?
add_torrent_params ret; add_torrent_params ret;
if (rd.dict_find_string_value("file-format") if (rd.dict_find_string_value("file-format")
@ -115,6 +117,7 @@ namespace libtorrent
ret.total_uploaded = rd.dict_find_int_value("total_uploaded"); ret.total_uploaded = rd.dict_find_int_value("total_uploaded");
ret.total_downloaded = rd.dict_find_int_value("total_downloaded"); ret.total_downloaded = rd.dict_find_int_value("total_downloaded");
ret.active_time = rd.dict_find_int_value("active_time"); ret.active_time = rd.dict_find_int_value("active_time");
ret.finished_time = rd.dict_find_int_value("finished_time"); ret.finished_time = rd.dict_find_int_value("finished_time");
ret.seeding_time = rd.dict_find_int_value("seeding_time"); ret.seeding_time = rd.dict_find_int_value("seeding_time");