Changeset 2029

Timestamp:

Jun 10, 2007, 7:36:07 PM (15 years ago)

Author:

joshe

Message:

Add possible replies for each message.

File:

• trunk/misc/ipcproto.txt (modified) (33 diffs)

trunk/misc/ipcproto.txt

@@ -121 +121 @@
 Version: 1
 Format:  list of strings
+Replies: "succeeded", "failed", "not-supported", "info"
 Example: 8:addfilesl21:/torrents/foo.torrent20:/home/me/bar.torrente
          "addfiles", ("/torrents/foo.torrent", /home/me/bar.torrent")
@@ -128 +129 @@
          deleted safely) is implementation dependent and may not
          currently be known or changed with this protocol.
-Replies: succeeded, failed, info
 
 Key:     "addfile-detailed"
 Version: 2
 Format:  dict
+Replies: "succeeded", "failed", "not-supported", "info"
 Example: 16:addfile-detailedd4:file19:/tor/wooble.torrente
          "addfile-detailed", {"file": "/tor/wooble.torrent"}
@@ -146 +147 @@
 Version: 2
 Format:  boolean
+Replies: "succeeded", "failed", "not-supported"
 Example: 7:automapi1e
          "automap", 1
-Details: Enable (1) or disable (0) automatic port mapping on the
-         server. Other integer values will likely be treated as 1 but
-         this shold not be relied upon.
+Details: Enable (1) or disable (0) automatic port mapping on the server.
 
 Key:     "autostart"
 Version: 2
 Format:  boolean
+Replies: "succeeded", "failed", "not-supported"
 Example: 9:autostarti0e
          "autostart", 0
 Details: Enable (1) or disable (0) automatic starting of new torrents
-         added via "addfiles" message.
+         added via "addfiles" or "addfiles-detailed" messages.
 
 Key:     "directory"
 Version: 2
 Format:  string
+Replies: "succeeded", "failed", "not-supported"
 Example: 9:directory21:/home/roger/downloads
          "directory", "/home/roger/downloads"
@@ -170 +172 @@
 Version: 2
 Format:  int
+Replies: "succeeded", "failed", "not-supported"
 Example: 9:downlimiti100e
          "downlimit", 100
@@ -178 +181 @@
 Version: 2
 Format:  string
+Replies: N/A
 Example: 6:failed17:permission denied
          "failed", "permission denied
@@ -185 +189 @@
 Version: 2
 Format:  value is ignored
+Replies: "failed", "not-supported", "automap"
 Example: 11:get-automap0:
          "get-automap", ""
@@ -192 +197 @@
 Version: 2
 Format:  value is ignored
+Replies: "failed", "not-supported", "autostart"
 Example: 13:get-autostart0:
          "get-autostart", ""
@@ -199 +205 @@
 Version: 2
 Format:  value is ignored
+Replies: "failed", "not-supported", "directory"
 Example: 13:get-directory0:
          "get-directory", ""
@@ -206 +213 @@
 Version: 2
 Format:  value is ignored
+Replies: "failed", "not-supported", "downlimit"
 Example: 13:get-downlimit0:
          "get-downlimit", ""
@@ -213 +221 @@
 Version: 2
 Format:  dict with keys "id" and "type" for lists of ints and strings
+Replies: "failed", "not-supported", "info"
 Example: 8:get-infod2:idli4ei7ei2ee4:typel4:hash4:nameee
          "get-info", {"id": (4, 7, 2), "type": ("hash", "name")}
@@ -226 +235 @@
 Version: 2
 Format:  list of strings
+Replies: "failed", "not-supported", "info"
 Example: 12:get-info-alll4:hash4:namee
          "get-info-all", ("hash", "name")
@@ -233 +243 @@
 Version: 2
 Format:  value is ignored
+Replies: "failed", "not-supported", "pex"
 Example: 7:get-pex0:
          "get-pex", ""
@@ -240 +251 @@
 Version: 2
 Format:  value is ignored
+Replies: "failed", "not-supported", "port"
 Example: 8:get-port0:
          "get-port", ""
@@ -247 +259 @@
 Version: 2
 Format:  dict with keys "id" and "type" for lists of ints and strings
+Replies: "failed", "not-supported", "status"
 Example: 10:get-statusd2:idli4ei7ei2ee4:typel5:state9:completedee
          "get-status", {"id": (4, 7, 4), "type": ("state", "completed")}
@@ -255 +268 @@
 Version: 2
 Format:  list of strings
+Replies: "failed", "not-supported", "status"
 Example: 14:get-status-alll5:state9:completede
          "get-status-all", ("state", "completed")
@@ -262 +276 @@
 Version: 2
 Format:  list of strings
+Replies: "failed", "not-supported", "supported"
 Example: 13:get-supportedl6:lookup8:get-port16:addfile-detailede
          "get-supported", ("lookup", "get-port", "addfile-detailed")
@@ -270 +285 @@
 Version: 2
 Format:  value is ignored
+Replies: "failed", "not-supported", "uplimit"
 Example: 11:get-uplimit0:
          "get-uplimit", ""
@@ -277 +293 @@
 Version: 2
 Format:  list of strings
+Replies: "failed", "not-supported", "info"
 Example: 6:lookupl40:0f16ea6965ee5133ea4dbb1e7f516e9fcf3d899ee
          "lookup", ("0f16ea6965ee5133ea4dbb1e7f516e9fcf3d899e")
@@ -285 +302 @@
 Version: 2
 Format:  list of dictionaries
+Replies: N/A
 Example: 4:infold2:idi3e4:name3:fooed2:idi9e4:name3:baree
          "info", ({"id": 4, "name": "foo"}, {"id": 9, "name": "bar"})
@@ -295 +313 @@
 Version: 2
 Format:  value is ignored
+Replies: "succeeded", "failed", "not-supported"
 Example: 4:noop0:
          "noop", ""
@@ -303 +322 @@
 Version: 2
 Format:  value is ignored
+Replies: N/A
 Example: 13:not-supported0:
          "not-supported", ""
@@ -311 +331 @@
 Version: 2
 Format:  boolean
+Replies: "succeeded", "failed", "not-supported"
 Example: 3:pexi0e
          "pex", 0
@@ -318 +339 @@
 Version: 2
 Format:  int between 0 and 65535
+Replies: "succeeded", "failed", "not-supported"
 Example: 4:porti9090e
          "port", 9090
@@ -326 +348 @@
 Version: 1
 Format:  value is ignored
+Replies: "succeeded", "failed", "not-supported"
 Example: 4:quit0:
          "quit", ""
-Details: Cause the server to quit.
+Details: Cause the server to quit. Note that the connection might be
+         closed without a response being sent.
 
 Key:     "remove"
 Version: 2
 Format:  list of torrent ID ints
+Replies: "succeeded", "failed", "not-supported"
 Example: 5:removeli3ei8ei6ee
          "remove", (3, 8, 6)
@@ -344 +369 @@
 Version: 2
 Format:  value is ignored
+Replies: "succeeded", "failed", "not-supported"
 Example: 10:remove-all0:
          "remove-all", ""
@@ -351 +377 @@
 Version: 2
 Format:  list of torrent ID ints
+Replies: "succeeded", "failed", "not-supported"
 Example: 5:startli3ei8ei6ee
          "start", (3, 8, 6)
@@ -358 +385 @@
 Version: 2
 Format:  value is ignored
+Replies: "succeeded", "failed", "not-supported"
 Example: 9:start-all0:
          "start-all", ""
@@ -365 +393 @@
 Version: 2
 Format:  list of dictionaries
+Replies: N/A
 Example: 4:infold2:idi3e5:state7:seedinged2:idi9e5:state6:pausedee
          "info", ({"id": 3, "state": "seeding"}, {"id": 9, "state" : "paused"})
@@ -372 +401 @@
 Version: 2
 Format:  list of torrent ID ints
+Replies: "succeeded", "failed", "not-supported"
 Example: 4:stopli3ei8ei6ee
          "stop", (3, 8, 6)
@@ -379 +409 @@
 Version: 2
 Format:  value is ignored
+Replies: "succeeded", "failed", "not-supported"
 Example: 8:stop-all0:
          "stop-all", ""
@@ -386 +417 @@
 Version: 2
 Format:  value is ignored
+Replies: N/A
 Example: 8:succeeded0:
          "succeeded", ""
@@ -394 +426 @@
 Version: 2
 Format:  list of strings
+Replies: N/A
 Example: 9:supportedl8:get-port6:lookupe
          "supported", ("get-port", "lookup")
@@ -402 +435 @@
 Version: 2
 Format:  int
+Replies: "succeeded", "failed", "not-supported"
 Example: 7:uplimiti20e
          "uplimit", 20