Changeset 5806


Ignore:
Timestamp:
May 10, 2008, 10:03:03 PM (14 years ago)
Author:
charles
Message:

revised the spec based on Gimp_ and hawkman's feedback: (1) made a manditory `result' argument to tell if a request was successful or not. (2) spec'ed out how to get/set a torrent's up/down speeds and peer limit (3) spec'ed out how to set file priorities and DND

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/ipc-json-spec.txt

    r5803 r5806  
    38382.3.  Response Body
    3939
    40    Response bodies support two members:
    41    (1) An optional "arguments" object of name/value pairs.
    42    (2) An optional "error" string which may be omitted on success.
     40   All response bodies support two members:
     41   (1) A required "result" string whose value must be "success" on success,
     42       and may be "no-permission", "bad-format", or "error" on failure.
     43   (2) An optional "arguments" object of name/value pairs.
     44       The contents of these arguments depend on the request's name.
    4345
    44463.  Torrent Requests
     
    9395         }
    9496         "body": {
     97            "result": "success",
    9598            "arguments": {
    9699               "info": [
     
    146149   Response arguments: 3.1's "error" if the request failed.
    147150
     1513.6.  Other torrent settings
     152
     153   Common arguments:
     154
     155   string             | value type & description
     156   -------------------+-------------------------------------------------
     157   "ids"              | array     see section 3.1
     158   "max-peers"        | int       maximum number of peers
     159   "speed-limit-down" | int       maximum download speed (in KiB/s)
     160   "speed-limit-up"   | int       maximum upload speed (in KiB/s)
     161
     1623.6.1.  Mutators
     163
     164   Request name: "torrent-set"
     165   Request arguments: one or more of 3.6's arguments
     166   Response arguments: none
     167
     1683.6.2.  Accessors
     169
     170   Request name: "torrent-get"
     171   Request arguments: none
     172   Response arguments: all of 3.6's arguments
     173
     1743.7  File Priorities
     175
     176   Common arguments:
     177
     178   string             | value type & description
     179   -------------------+-------------------------------------------------
     180   "ids"              | array     see section 3.1
     181   "priority-high"    | array     indices of one or more high-priority files
     182   "priority-low"     | array     indices of one or more low-priority files
     183   "priority-normal"  | array     indices of one or more normal-priority files
     184   "download"         | array     indices of one or more file to download
     185   "no-download"      | array     indices of one or more file to not download
     186
     1873.7.1.  Mutators
     188
     189    Request name: "torrent-set-file"
     190    Request arguments: one or more of 3.7's arguments
     191    Response arguments: none
     192
     1933.7.2.  Accessors
     194
     195    Request name: "torrent-get-file"
     196    Request arguments: none
     197    Response arguments: all of 3.6's arguments   
     198   
    1481994.   Session Status Requests
    149200
Note: See TracChangeset for help on using the changeset viewer.