Changeset 7714

Timestamp:

Jan 16, 2009, 12:58:11 AM (12 years ago)

Author:

charles

Message:

(1.5x) add interface versioning to the RPC spec

Location:

branches/1.5x

Files:

• doc/rpc-spec.txt (modified) (5 diffs)
• libtransmission/rpcimpl.c (modified) (1 diff)

branches/1.5x/doc/rpc-spec.txt

@@ -69 +69 @@
    Method name         | libtransmission function
    --------------------+-------------------------------------------------
-   "torrent-remove"    | tr_torrentRemove
    "torrent-start"     | tr_torrentStart
    "torrent-stop"      | tr_torrentStop
@@ -134 +133 @@
    doneDate               | number                               | tr_stat
    downloadedEver         | number                               | tr_stat
+   downloaders            | number                               | tr_stat
    downloadLimitMode      | number                               | tr_torrent
    downloadLimit          | number                               | tr_torrent
@@ -293 +293 @@
                        fields for id, name, and hashString.
 
+3.5.  Removing a Torrent
+
+   Method name: "torrent-remove"
+
+   Request arguments:
+
+   string                     | value type & description
+   ---------------------------+-------------------------------------------------
+   "ids"                      | array      torrent list, as described in 3.1
+   "delete-local-data"        | 'boolean'  delete local data. (default: false)
+
+   Response arguments: none
+
 
 4.   Session Requests
@@ -311 +324 @@
    "speed-limit-up-enabled"   | 'boolean'  true means enabled
    "version"                  | string     long version string "$version ($revision)"
-
+   "rpc-version"              | number     the current RPC API version
+   "rpc-version-minimum"      | number     the minimum RPC API version supported
+
+   "rpc-version" indicates the RPC interface version supported by the RPC server.
+   It is incremented when a new version of Transmission changes the RPC interface.
+
+   "rpc-version-minimum" indicates the oldest API supported by the RPC server.
+   It is changes when a new version of Transmission changes the RPC interface
+   in a way that is not backwards compatible.  There are no plans for this
+   to be common behavior.
 
 4.1.1.  Mutators
@@ -342 +364 @@
    
 
+5.0.  Protocol Versions
+
+  The following changes have been made to the RPC interface:
+
+   RPC   | Release | Backwards |                |
+   Vers. | Version | Compat?   | Method         | Description
+   ------+---------+-----------+----------------+-------------------------------
+   1     | 1.30    | n/a       | n/a            | Initial version
+   ------+---------+-----------+----------------+-------------------------------
+   2     | 1.34    | yes       | torrent-get    | new arg "peers"
+   ------+---------+-----------+----------------+-------------------------------
+   3     | 1.41    | yes       | torrent-get    | added "port" to "peers"
+         |         |           | torrent-get    | new arg "downloaders"
+         |         |           | session-get    | new arg "version"
+         |         |           | torrent-remove | new method
+   ------+---------+-----------+----------------+-------------------------------
+   4     | 1.50    | yes       | session-get    | new arg "rpc-version"
+         |         |           | session-get    | new arg "rpc-version-minimum"
+   ------+---------+-----------+----------------+-------------------------------
+

branches/1.5x/libtransmission/rpcimpl.c

@@ -723 +723 @@
     tr_bencDictAddInt( d, "port", tr_sessionGetPeerPort( session ) );
     tr_bencDictAddInt( d, "port-forwarding-enabled", tr_sessionIsPortForwardingEnabled( session ) );
+    tr_bencDictAddInt( d, "rpc-version", 4 );
+    tr_bencDictAddInt( d, "rpc-version-minimum", 1 );
     tr_bencDictAddInt( d, "speed-limit-up", tr_sessionGetSpeedLimit( session, TR_UP ) );
     tr_bencDictAddInt( d, "speed-limit-up-enabled", tr_sessionIsSpeedLimitEnabled( session, TR_UP ) );