Ignore:
Timestamp:
Mar 4, 2009, 7:52:57 PM (13 years ago)
Author:
charles
Message:

(trunk) libT and gtk+ parts for #1889: per-torrent vs. global speed limit confusion

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/rpc-spec.txt

    r7992 r8021  
    9393   Request arguments:
    9494
    95    string                     | value type & description
    96    ---------------------------+-------------------------------------------------
    97    "files-wanted"             | array      indices of file(s) to download
    98    "files-unwanted"           | array      indices of file(s) to not download
    99    "ids"                      | array      torrent list, as described in 3.1
    100    "peer-limit"               | number     maximum number of peers
    101    "priority-high"            | array      indices of high-priority file(s)
    102    "priority-low"             | array      indices of low-priority file(s)
    103    "priority-normal"          | array      indices of normal-priority file(s)
    104    "speed-limit-down"         | number     maximum download speed (in K/s)
    105    "speed-limit-down-enabled" | 'boolean'  true if the download speed is limited
    106    "speed-limit-up"           | number     maximum upload speed (in K/s)
    107    "speed-limit-up-enabled"   | 'boolean'  true if the upload speed is limited
     95   string                            | value type & description
     96   ----------------------------------+-------------------------------------------------
     97   "files-wanted"                    | array      indices of file(s) to download
     98   "files-unwanted"                  | array      indices of file(s) to not download
     99   "ids"                             | array      torrent list, as described in 3.1
     100   "peer-limit"                      | number     maximum number of peers
     101   "priority-high"                   | array      indices of high-priority file(s)
     102   "priority-low"                    | array      indices of low-priority file(s)
     103   "priority-normal"                 | array      indices of normal-priority file(s)
     104   "speed-limit-down"                | number     maximum download speed (in K/s)
     105   "speed-limit-down-enabled"        | 'boolean'  true if the download speed is limited
     106   "speed-limit-down-global-enabled" | 'boolean'  true if the download speed is limited by session
     107   "speed-limit-up"                  | number     maximum upload speed (in K/s)
     108   "speed-limit-up-enabled"          | 'boolean'  true if the upload speed is limited
     109   "speed-limit-up-global-enabled"   | 'boolean'  true if the upload speed is limited by session
    108110
    109111   Just as an empty "ids" value is shorthand for "all ids", using an empty array
     
    127129       the key/value pairs matching the request's "fields" argument.
    128130
    129    key                    | type                                 | source
    130    -----------------------+--------------------------------------+---------
    131    activityDate           | number                               | tr_stat
    132    addedDate              | number                               | tr_stat
    133    announceResponse       | string                               | tr_stat
    134    announceURL            | string                               | tr_stat
    135    comment                | string                               | tr_info
    136    corruptEver            | number                               | tr_stat
    137    creator                | string                               | tr_info
    138    dateCreated            | number                               | tr_info
    139    desiredAvailable       | number                               | tr_stat
    140    doneDate               | number                               | tr_stat
    141    downloadDir            | string                               | tr_torrent
    142    downloadedEver         | number                               | tr_stat
    143    downloaders            | number                               | tr_stat
    144    downloadLimitMode      | number                               | tr_torrent
    145    downloadLimit          | number                               | tr_torrent
    146    error                  | number                               | tr_stat
    147    errorString            | number                               | tr_stat
    148    eta                    | number                               | tr_stat
    149    files                  | array (see below)                    | n/a
    150    hashString             | string                               | tr_info
    151    haveUnchecked          | number                               | tr_stat
    152    haveValid              | number                               | tr_stat
    153    id                     | number                               | tr_torrent
    154    isPrivate              | 'boolean                             | tr_torrent
    155    lastAnnounceTime       | number                               | tr_stat
    156    lastScrapeTime         | number                               | tr_stat
    157    leechers               | number                               | tr_stat
    158    leftUntilDone          | number                               | tr_stat
    159    manualAnnounceTime     | number                               | tr_stat
    160    maxConnectedPeers      | number                               | tr_torrent
    161    name                   | string                               | tr_info
    162    nextAnnounceTime       | number                               | tr_stat
    163    nextScrapeTime         | number                               | tr_stat
    164    peers                  | array (see below)                    | n/a
    165    peersConnected         | number                               | tr_stat
    166    peersFrom              | object (see below)                   | n/a
    167    peersGettingFromUs     | number                               | tr_stat
    168    peersKnown             | number                               | tr_stat
    169    peersSendingToUs       | number                               | tr_stat
    170    pieces                 | string (see below)                   | tr_torrent
    171    pieceCount             | tnumber                              | tr_info
    172    pieceSize              | tnumber                              | tr_info
    173    priorities             | array (see below)                    | n/a
    174    rateDownload (B/s)     | number                               | tr_stat
    175    rateUpload (B/s)       | number                               | tr_stat
    176    recheckProgress        | 'double'                             | tr_stat
    177    scrapeResponse         | string                               | tr_stat
    178    scrapeURL              | string                               | tr_stat
    179    seeders                | number                               | tr_stat
    180    sizeWhenDone           | number                               | tr_stat
    181    startDate              | number                               | tr_stat
    182    status                 | number                               | tr_stat
    183    swarmSpeed (K/s)       | number                               | tr_stat
    184    timesCompleted         | number                               | tr_stat
    185    trackers               | array (see below)                    | n/a
    186    totalSize              | number                               | tr_info
    187    uploadedEver           | number                               | tr_stat
    188    uploadLimitMode        | number                               | tr_torrent
    189    uploadLimit            | number                               | tr_torrent
    190    uploadRatio            | 'double'                             | tr_stat
    191    wanted                 | array (see below)                    | n/a
    192    webseeds               | array (see below)                    | n/a
    193    webseedsSendingToUs    | number                               | tr_stat
    194                           |                                      |
    195                           |                                      |
    196    -----------------------+--------------------------------------+
     131   key                             | type                        | source
     132   --------------------------------+-----------------------------+---------
     133   activityDate                    | number                      | tr_stat
     134   addedDate                       | number                      | tr_stat
     135   announceResponse                | string                      | tr_stat
     136   announceURL                     | string                      | tr_stat
     137   comment                         | string                      | tr_info
     138   corruptEver                     | number                      | tr_stat
     139   creator                         | string                      | tr_info
     140   dateCreated                     | number                      | tr_info
     141   desiredAvailable                | number                      | tr_stat
     142   doneDate                        | number                      | tr_stat
     143   downloadDir                     | string                      | tr_torrent
     144   downloadedEver                  | number                      | tr_stat
     145   downloaders                     | number                      | tr_stat
     146   error                           | number                      | tr_stat
     147   errorString                     | number                      | tr_stat
     148   eta                             | number                      | tr_stat
     149   files                           | array (see below)           | n/a
     150   hashString                      | string                      | tr_info
     151   haveUnchecked                   | number                      | tr_stat
     152   haveValid                       | number                      | tr_stat
     153   id                              | number                      | tr_torrent
     154   isPrivate                       | 'boolean'                   | tr_torrent
     155   lastAnnounceTime                | number                      | tr_stat
     156   lastScrapeTime                  | number                      | tr_stat
     157   leechers                        | number                      | tr_stat
     158   leftUntilDone                   | number                      | tr_stat
     159   manualAnnounceTime              | number                      | tr_stat
     160   maxConnectedPeers               | number                      | tr_torrent
     161   name                            | string                      | tr_info
     162   nextAnnounceTime                | number                      | tr_stat
     163   nextScrapeTime                  | number                      | tr_stat
     164   peers                           | array (see below)           | n/a
     165   peersConnected                  | number                      | tr_stat
     166   peersFrom                       | object (see below)          | n/a
     167   peersGettingFromUs              | number                      | tr_stat
     168   peersKnown                      | number                      | tr_stat
     169   peersSendingToUs                | number                      | tr_stat
     170   pieces                          | string (see below)          | tr_torrent
     171   pieceCount                      | tnumber                     | tr_info
     172   pieceSize                       | tnumber                     | tr_info
     173   priorities                      | array (see below)           | n/a
     174   rateDownload (B/s)              | number                      | tr_stat
     175   rateUpload (B/s)                | number                      | tr_stat
     176   recheckProgress                 | 'double'                    | tr_stat
     177   scrapeResponse                  | string                      | tr_stat
     178   scrapeURL                       | string                      | tr_stat
     179   seeders                         | number                      | tr_stat
     180   sizeWhenDone                    | number                      | tr_stat
     181   speed-limit-down                | number                      | tr_torrent
     182   speed-limit-down-enabled        | 'boolean'                   | tr_torrent
     183   speed-limit-down-global-enabled | 'boolean'                   | tr_torrent
     184   speed-limit-up                  | number                      | tr_torrent
     185   speed-limit-up-enabled          | 'boolean'                   | tr_torrent
     186   speed-limit-up-global-enabled   | 'boolean'                   | tr_torrent
     187   startDate                       | number                      | tr_stat
     188   status                          | number                      | tr_stat
     189   swarmSpeed (K/s)                | number                      | tr_stat
     190   timesCompleted                  | number                      | tr_stat
     191   trackers                        | array (see below)           | n/a
     192   totalSize                       | number                      | tr_info
     193   uploadedEver                    | number                      | tr_stat
     194   uploadLimitMode                 | number                      | tr_torrent
     195   uploadLimit                     | number                      | tr_torrent
     196   uploadRatio                     | 'double'                    | tr_stat
     197   wanted                          | array (see below)           | n/a
     198   webseeds                        | array (see below)           | n/a
     199   webseedsSendingToUs             | number                      | tr_stat
     200                                   |                             |
     201                                   |                             |
     202   -----------------------+--------+-----------------------------+
    197203   files                  | array of objects, each containing:   |
    198204                          +-------------------------+------------+
     
    408414   ------+---------+-----------+----------------+-------------------------------
    409415   3     | 1.41    | yes       | torrent-get    | added "port" to "peers"
    410          |         |           | torrent-get    | new arg "downloaders"
    411          |         |           | session-get    | new arg "version"
    412          |         |           | torrent-remove | new method
     416         |         | yes       | torrent-get    | new arg "downloaders"
     417         |         | yes       | session-get    | new arg "version"
     418         |         | yes       | torrent-remove | new method
    413419   ------+---------+-----------+----------------+-------------------------------
    414420   4     | 1.50    | yes       | session-get    | new arg "rpc-version"
    415          |         |           | session-get    | new arg "rpc-version-minimum"
    416          |         |           | session-stats  | added "cumulative-stats"
    417          |         |           | session-stats  | added "current-stats"
    418          |         |           | torrent-get    | new arg "downloadDir"
     421         |         | yes       | session-get    | new arg "rpc-version-minimum"
     422         |         | yes       | session-stats  | added "cumulative-stats"
     423         |         | yes       | session-stats  | added "current-stats"
     424         |         | yes       | torrent-get    | new arg "downloadDir"
    419425   ------+---------+-----------+----------------+-------------------------------
    420426   6     | 1.60    | yes       | torrent-get    | new arg "pieces"
    421    ------+---------+-----------+----------------+-------------------------------
    422 
    423 
     427         |         | yes       | torrent-set    | new arg "speed-limit-down-global-enabled"
     428         |         | yes       | torrent-set    | new arg "speed-limit-up-global-enabled"
     429         |         | yes       | torrent-get    | new arg "speed-limit-down"
     430         |         | yes       | torrent-get    | new arg "speed-limit-down-enabled"
     431         |         | yes       | torrent-get    | new arg "speed-limit-down-global-enabled"
     432         |         | yes       | torrent-get    | new arg "speed-limit-up"
     433         |         | yes       | torrent-get    | new arg "speed-limit-up-enabled"
     434         |         | yes       | torrent-get    | new arg "speed-limit-up-global-enabled"
     435         |         |        NO | torrent-get    | removed arg "downloadLimit"
     436         |         |        NO | torrent-get    | removed arg "downloadLimitMode"
     437         |         |        NO | torrent-get    | removed arg "uploadLimit"
     438         |         |        NO | torrent-get    | removed arg "uploadLimitMode"
     439   ------+---------+-----------+----------------+-------------------------------
     440
     441
Note: See TracChangeset for help on using the changeset viewer.