Changeset 5813

Timestamp:

May 12, 2008, 12:41:55 AM (14 years ago)

Author:

charles

Message:

partial implementation of json-ipc backend: torrent start/stop/close/verify/stat/info, as are getting & setting per-torrent peer limits, upload speeds, and download speeds. this is a work in progress.

Location:

trunk

Files:

• doc/ipc-json-spec.txt (modified) (9 diffs)
• libtransmission/Makefile.am (modified) (2 diffs)
• libtransmission/ipc.c (added)
• libtransmission/ipc.h (added)
• libtransmission/torrent.c (modified) (2 diffs)
• libtransmission/torrent.h (modified) (2 diffs)

trunk/doc/ipc-json-spec.txt

@@ -13 +13 @@
 2.  Message Format
 
-   The entire protocol is formatted in a subset of JSON that understands
+   Messages are formatted in a subset of JSON that understands
    arrays, maps, strings, and whole numbers with no exponentials --
    in short, the subset of JSON easily represented in benc.
@@ -21 +21 @@
    There are only two message types: request and response.  Both
    are JSON objects with two members:  "headers" (described in 2.1)
-   and "body" (described in 2.2-2.3).
+   and "body" (described in 2.2 - 2.3).
 
 2.1.  Headers
@@ -46 +46 @@
 3.  Torrent Requests
 
-3.1.  Common Arguments
-
-   Most torrent requests support an "ids" argument, which is a list
-   containing unique torrent ids, or torrent sha1 hash strings, or both.
-   These are the torrents that the request will be applied to.
-   If "ids" is omitted, the request is applied to all torrents.
-
-3.2.  Torrent Action Requests
+3.1.  Torrent Action Requests
 
    Request names: "torrent-start", "torrent-stop",
                   "torrent-remove", "torrent-verify"
-   Request arguments: 3.1's optional "ids" argument.
+   Request arguments: "ids", a list of unique torrent ids, sha1 hash strings,
+                      or both.  These are the torrents that the request will
+                      be applied to.  If "ids" is ommitted, the request is
+                      applied to all torrents.
    Response arguments: none.
 
-3.3.  Torrent Info Requests
+3.2.  Torrent Info Requests
 
    Request name: "torrent-info".
@@ -119 +115 @@
       }
 
-3.4.  Torrent Status Requests
+3.3.  Torrent Status Requests
 
    Request name is "torrent-status".
@@ -131 +127 @@
    (3) a new string, "scrape-url", is added
 
-3.5.  Adding a Torrent
+3.4.  Adding a Torrent
 
    Request name: "torrent-add"
@@ -147 +143 @@
    The "filename" argument is required; all others are optional.
 
-   Response arguments: 3.1's "error" if the request failed.
-
-3.6.  Other torrent settings
+   Response arguments: none.
+
+3.5.  Other torrent settings
 
    Common arguments:
@@ -155 +151 @@
    string             | value type & description
    -------------------+-------------------------------------------------
-   "id"               | int or string  torrent id or hash string
    "max-peers"        | int            maximum number of peers
    "speed-limit-down" | int            maximum download speed (in KiB/s)
    "speed-limit-up"   | int            maximum upload speed (in KiB/s)
 
-3.6.1.  Mutators
+3.5.1.  Mutators
 
    Request name: "torrent-set"
-   Request arguments: "id" from 3.6, plus one or more of 3.6's other arguments
+   Request arguments: 3.1's "ids", plus one or more of 3.5's arguments
    Response arguments: none
 
-3.6.2.  Accessors
+3.5.2.  Accessors
 
    Request name: "torrent-get"
    Request arguments: none
-   Response arguments: all of 3.6's arguments
-
-3.7  File Priorities
+   Response arguments: "torrents", a list of torrent objects containing
+                       all of 3.5's arguments plus the id passed in
+                       by "torrent-set".
+                      
+
+3.6  File Priorities
 
    Common arguments:
@@ -178 +176 @@
    string             | value type & description
    -------------------+-------------------------------------------------
-   "id"               | int or string  torrent id or hash string
    "priority-high"    | array          indices of one or more high-priority files
    "priority-low"     | array          indices of one or more low-priority files
@@ -185 +182 @@
    "no-download"      | array          indices of one or more file to not download
 
-3.7.1.  Mutators
+3.6.1.  Mutators
 
     Request name: "torrent-set-file"
-    Request arguments: "id" from 3.7, plus one or more of 3.7's other arguments
+    Request arguments: 3.1's "ids", plus one or more of 3.6's arguments
     Response arguments: none
 
-3.7.2.  Accessors
+3.6.2.  Accessors
 
     Request name: "torrent-get-file"
     Request arguments: none
-    Response arguments: all of 3.7's arguments
+   Response arguments: list of objects, one per torrent, containing
+                       all of 3.6's arguments plus the id passed in
+                       by "torrent-set".
    
 4.   Session Status Requests

trunk/libtransmission/Makefile.am

@@ -17 +17 @@
     handshake.c \
     inout.c \
+    ipc.c \
     ipcparse.c \
     json.c \
@@ -57 +58 @@
     handshake.h \
     inout.h \
+    ipc.h \
     ipcparse.h \
     list.h \

trunk/libtransmission/torrent.c

@@ -54 +54 @@
 ***/
 
+tr_torrent*
+tr_torrentFindFromId( tr_handle * handle, int id )
+{
+    tr_torrent * tor = NULL;
+
+    while(( tor = tr_torrentNext( handle, tor )))
+        if( tor->uniqueId == id )
+            return tor;
+
+    return NULL;
+}
+
+tr_torrent*
+tr_torrentFindFromHashString( tr_handle * handle, const char * str )
+{
+    tr_torrent * tor = NULL;
+
+    while(( tor = tr_torrentNext( handle, tor )))
+        if( !strcmp( str, tor->info.hashString ) )
+            return tor;
+
+    return NULL;
+}
+
 int
 tr_torrentExists( const tr_handle * handle,
@@ -369 +393 @@
     uint64_t t;
     tr_info * info = &tor->info;
+    static int nextUniqueId = 1;
    
     tr_globalLock( h );
 
     tor->handle   = h;
+    tor->uniqueId = nextUniqueId++;
 
     randomizeTiers( info );

trunk/libtransmission/torrent.h

@@ -50 +50 @@
 
 int tr_torrentExists( const tr_handle *, const uint8_t * );
+tr_torrent* tr_torrentFindFromId( tr_handle *, int id );
 tr_torrent* tr_torrentFindFromHash( tr_handle *, const uint8_t * );
+tr_torrent* tr_torrentFindFromHashString( tr_handle *, const char * );
 tr_torrent* tr_torrentFindFromObfuscatedHash( tr_handle *, const uint8_t* );
 
@@ -179 +181 @@
 
     tr_torrent               * next;
+
+    int                        uniqueId;
 };