Changeset 11035


Ignore:
Timestamp:
Jul 23, 2010, 1:19:13 AM (12 years ago)
Author:
livings124
Message:

update the RPC spec for #2560

File:
1 edited

Legend:

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

    r10937 r11035  
    101101   "priority-low"        | array      indices of low-priority file(s)
    102102   "priority-normal"     | array      indices of normal-priority file(s)
    103    "seedRatioLimit"      | double     session seeding ratio
     103   "seedInactiveLimit"   | number     torrent-level number of minutes of seeding inactivity
     104   "seedInactiveMode"    | number     which seeding inactivity to use.  See tr_inactvelimit
     105   "seedRatioLimit"      | double     torrent-level seeding ratio
    104106   "seedRatioMode"       | number     which ratio to use.  See tr_ratiolimit
    105107   "trackerAdd"          | object     (see below)
     
    141143   Request arguments:
    142144
    143    (1) An opional "ids" array as described in 3.1.
     145   (1) An optional "ids" array as described in 3.1.
    144146   (2) A required "fields" array of keys. (see list below)
    145147
     
    204206   rateUpload (B/s)            | number                      | tr_stat
    205207   recheckProgress             | double                      | tr_stat
     208   seedInactiveLimit           | number                      | tr_torrent
     209   seedInactiveMode            | number                      | tr_inactvelimit
    206210   seedRatioLimit              | double                      | tr_torrent
    207211   seedRatioMode               | number                      | tr_ratiolimit
     
    4174214.1.  Session Arguments
    418422
    419    string                        | value type & description
    420    ------------------------------+-------------------------------------------------
    421    "alt-speed-down"              | number     max global download speed (KBps)
    422    "alt-speed-enabled"           | boolean    true means use the alt speeds
    423    "alt-speed-time-begin"        | number     when to turn on alt speeds (units: minutes after midnight)
    424    "alt-speed-time-enabled"      | boolean    true means the scheduled on/off times are used
    425    "alt-speed-time-end"          | number     when to turn off alt speeds (units: same)
    426    "alt-speed-time-day"          | number     what day(s) to turn on alt speeds (look at tr_sched_day)
    427    "alt-speed-up"                | number     max global upload speed (KBps)
    428    "blocklist-enabled"           | boolean    true means enabled
    429    "blocklist-size"              | number     number of rules in the blocklist
    430    "cache-size"                  | number     maximum size of the disk cache (MB)
    431    "config-dir"                  | string     location of transmission's configuration directory
    432    "download-dir"                | string     default path to download torrents
    433    "dht-enabled"                 | boolean    true means allow dht in public torrents
    434    "encryption"                  | string     "required", "preferred", "tolerated"
    435    "incomplete-dir"              | string     path for incomplete torrents, when enabled
    436    "incomplete-dir-enabled"      | boolean    true means keep torrents in incomplete-dir until done
    437    "lpd-enabled"                 | boolean    true means allow Local Peer Discovery in public torrents
    438    "peer-limit-global"           | number     maximum global number of peers
    439    "peer-limit-per-torrent"      | number     maximum global number of peers
    440    "pex-enabled"                 | boolean    true means allow pex in public torrents
    441    "peer-port"                   | number     port number
    442    "peer-port-random-on-start"   | boolean    true means pick a random peer port on launch
    443    "port-forwarding-enabled"     | boolean    true means enabled
    444    "rename-partial-files"        | boolean    true means append ".part" to incomplete files
    445    "rpc-version"                 | number     the current RPC API version
    446    "rpc-version-minimum"         | number     the minimum RPC API version supported
    447    "script-torrent-done-filename"| string     filename of the script to run
    448    "script-torrent-done-enabled" | boolean    whether or not to call the "done" script
    449    "seedRatioLimit"              | double     the default seed ratio for torrents to use
    450    "seedRatioLimited"            | boolean    true if seedRatioLimit is honored by default
    451    "speed-limit-down"            | number     max global download speed (KBps)
    452    "speed-limit-down-enabled"    | boolean    true means enabled
    453    "speed-limit-up"              | number     max global upload speed (KBps)
    454    "speed-limit-up-enabled"      | boolean    true means enabled
    455    "start-added-torrents"        | boolean    true means added torrents will be started right away
    456    "trash-original-torrent-files"| boolean    true means the .torrent file of added torrents will be deleted
    457    "version"                     | string     long version string "$version ($revision)"
     423   string                           | value type & description
     424   ---------------------------------+-------------------------------------------------
     425   "alt-speed-down"                 | number     max global download speed (KBps)
     426   "alt-speed-enabled"              | boolean    true means use the alt speeds
     427   "alt-speed-time-begin"           | number     when to turn on alt speeds (units: minutes after midnight)
     428   "alt-speed-time-enabled"         | boolean    true means the scheduled on/off times are used
     429   "alt-speed-time-end"             | number     when to turn off alt speeds (units: same)
     430   "alt-speed-time-day"             | number     what day(s) to turn on alt speeds (look at tr_sched_day)
     431   "alt-speed-up"                   | number     max global upload speed (KBps)
     432   "blocklist-enabled"              | boolean    true means enabled
     433   "blocklist-size"                 | number     number of rules in the blocklist
     434   "cache-size"                     | number     maximum size of the disk cache (MB)
     435   "config-dir"                     | string     location of transmission's configuration directory
     436   "download-dir"                   | string     default path to download torrents
     437   "dht-enabled"                    | boolean    true means allow dht in public torrents
     438   "encryption"                     | string     "required", "preferred", "tolerated"
     439   "inactive-seeding-limit"         | number     the default seed inactivity limit for torrents to use
     440   "inactive-seeding-limit-enabled" | boolean    true if the seeding inactivity limit is honored by default
     441   "incomplete-dir"                 | string     path for incomplete torrents, when enabled
     442   "incomplete-dir-enabled"         | boolean    true means keep torrents in incomplete-dir until done
     443   "lpd-enabled"                    | boolean    true means allow Local Peer Discovery in public torrents
     444   "peer-limit-global"              | number     maximum global number of peers
     445   "peer-limit-per-torrent"         | number     maximum global number of peers
     446   "pex-enabled"                    | boolean    true means allow pex in public torrents
     447   "peer-port"                      | number     port number
     448   "peer-port-random-on-start"      | boolean    true means pick a random peer port on launch
     449   "port-forwarding-enabled"        | boolean    true means enabled
     450   "rename-partial-files"           | boolean    true means append ".part" to incomplete files
     451   "rpc-version"                    | number     the current RPC API version
     452   "rpc-version-minimum"            | number     the minimum RPC API version supported
     453   "script-torrent-done-filename"   | string     filename of the script to run
     454   "script-torrent-done-enabled"    | boolean    whether or not to call the "done" script
     455   "seedRatioLimit"                 | double     the default seed ratio for torrents to use
     456   "seedRatioLimited"               | boolean    true if seedRatioLimit is honored by default
     457   "speed-limit-down"               | number     max global download speed (KBps)
     458   "speed-limit-down-enabled"       | boolean    true means enabled
     459   "speed-limit-up"                 | number     max global upload speed (KBps)
     460   "speed-limit-up-enabled"         | boolean    true means enabled
     461   "start-added-torrents"           | boolean    true means added torrents will be started right away
     462   "trash-original-torrent-files"   | boolean    true means the .torrent file of added torrents will be deleted
     463   "version"                        | string     long version string "$version ($revision)"
    458464
    459465   "rpc-version" indicates the RPC interface version supported by the RPC server.
     
    631637   10    | 2.10    | yes       | session-get    | new arg "cache-size"
    632638         |         | yes       | session-set    | new arg "trash-original-torrent-files"
    633          |         | yes       | session-get    | new arg "start-added-torrents"
    634639         |         | yes       | session-get    | new arg "trash-original-torrent-files"
    635640         |         | yes       | torrent-get    | new arg "isFinished"
     
    637642         |         | yes       | torrent-set    | new arg "trackerEdit"
    638643         |         | yes       | torrent-set    | new arg "trackerRemove"
     644         |         | yes       | session-set    | new arg "inactive-seeding-limit"
     645         |         | yes       | session-set    | new arg "inactive-seeding-limit-enabled"
     646         |         | yes       | session-get    | new arg "inactive-seeding-limit"
     647         |         | yes       | session-get    | new arg "inactive-seeding-limit-enabled"
     648         |         | yes       | torrent-set    | new arg "seedInactiveLimit"
     649         |         | yes       | torrent-set    | new arg "seedInactiveMode"
     650         |         | yes       | torrent-get    | new arg "seedInactiveLimit"
     651         |         | yes       | torrent-get    | new arg "seedInactiveMode"
Note: See TracChangeset for help on using the changeset viewer.