Changeset 6766


Ignore:
Timestamp:
Sep 16, 2008, 5:33:13 PM (13 years ago)
Author:
charles
Message:

(doc 1.3x) backport rpc spec clarifications from r6647

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/1.3x/doc/rpc-spec.txt

    r6590 r6766  
    9494   "speed-limit-up"           | number     maximum upload speed (in K/s)
    9595   "speed-limit-up-enabled"   | 'boolean'  true if the upload speed is limited
     96
     97   Just as an empty "ids" value is shorthand for "all ids", using an empty array
     98   for "files-wanted", "files-unwanted", "priority-high", "priority-low", or
     99   "priority-normal" is shorthand for saying "all files".
    96100
    97101   Response arguments: none
     
    152156   pieceSize              | tnumber                              | tr_info
    153157   priorities             | array (see below)                    | n/a
    154    rateDownload           | number                               | tr_stat
    155    rateUpload             | number                               | tr_stat
     158   rateDownload (B/s)     | number                               | tr_stat
     159   rateUpload (B/s)       | number                               | tr_stat
    156160   recheckProgress        | number                               | tr_stat
    157161   scrapeResponse         | string                               | tr_stat
     
    176180   -----------------------+--------------------------------------+
    177181   files                  | array of objects, each containing:   |
    178                           +------------------+-------------------+
    179                           | key              | type              |
    180                           | bytesCompleted   | number            | tr_torrent
    181                           | length           | number            | tr_info
    182                           | name             | string            | tr_info
     182                          +-------------------------+------------+
     183                          | key                     | type       |
     184                          | bytesCompleted          | number     | tr_torrent
     185                          | length                  | number     | tr_info
     186                          | name                    | string     | tr_info
    183187   -----------------------+--------------------------------------+
    184188   peersFrom              | an object containing:                |
    185                           +------------------+-------------------+
    186                           | fromCache        | number            | tr_stat
    187                           | fromIncoming     | number            | tr_stat
    188                           | fromPex          | number            | tr_stat
    189                           | fromTracker      | number            | tr_stat
     189                          +-------------------------+------------+
     190                          | fromCache               | number     | tr_stat
     191                          | fromIncoming            | number     | tr_stat
     192                          | fromPex                 | number     | tr_stat
     193                          | fromTracker             | number     | tr_stat
    190194   -----------------------+--------------------------------------+
    191195   priorities             | an array of tr_info.filecount        | tr_info
     
    194198   -----------------------+--------------------------------------+
    195199   trackers               | array of objects, each containing:   |
    196                           +------------------+-------------------+
    197                           | announce         | string            | tr_info
    198                           | scrape           | string            | tr_info
    199                           | tier             | number            | tr_info
     200                          +-------------------------+------------+
     201                          | announce                | string     | tr_info
     202                          | scrape                  | string     | tr_info
     203                          | tier                    | number     | tr_info
    200204   -----------------------+--------------------------------------+
    201205   wanted                 | an array of tr_info.fileCount        | tr_info
     
    204208   -----------------------+--------------------------------------+
    205209   webseeds               | an array of strings:                 |
    206                           +------------------+-------------------+
    207                           | webseed          | string            | tr_info
    208                           +------------------+-------------------+
     210                          +-------------------------+------------+
     211                          | webseed                 | string     | tr_info
     212                          +-------------------------+------------+
    209213
    210214   Example:
Note: See TracChangeset for help on using the changeset viewer.