mirrors/deluge
1
0
Fork 0
mirror of https://git.deluge-torrent.org/deluge synced 2025-04-20 03:24:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

setup automatically generating the core's rpc api

Browse source
This commit is contained in:
Damien Churchill 2009-07-20 10:51:33 +00:00
parent 8a25bd4adc
commit 698d37f535
12 changed files with 630 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
deluge/_rpcapi.py Normal file
View file

@ -0,0 +1,20 @@
from new import classobj
from deluge.core.core import Core
from deluge.core.daemon import Daemon
class RpcApi:
pass
def scan_for_methods(obj):
methods = {
'__doc__': 'Methods available in %s' % obj.__name__.lower()
}
for d in dir(obj):
if not hasattr(getattr(obj,d), '_rpcserver_export'):
continue
methods[d] = getattr(obj, d)
cobj = classobj(obj.__name__.lower(), (object,), methods)
setattr(RpcApi, obj.__name__.lower(), cobj)
scan_for_methods(Core)
scan_for_methods(Daemon)

BIN
docs/build/doctrees/core/index.doctree vendored
View file

Binary file not shown.

BIN
docs/build/doctrees/core/rpc.doctree vendored Normal file
View file

Binary file not shown.

BIN
docs/build/doctrees/environment.pickle vendored
View file

Binary file not shown.

3
docs/build/html/_sources/core/rpc.txt vendored
View file

@ -101,4 +101,5 @@ daemon's state that the clients need to be made aware of.
Remote API
----------
TODO
.. autoclass:: deluge._rpcapi.RpcApi
:members:

342
docs/build/html/core/rpc.html vendored
View file

@ -135,7 +135,347 @@ being emitted.</dd>
</div>
<div class="section" id="remote-api">
<h2>Remote API<a class="headerlink" href="#remote-api" title="Permalink to this headline"></a></h2>
<p>TODO</p>
<dl class="class">
<dt id="deluge._rpcapi.RpcApi">
<em class="property">
class </em><tt class="descclassname">deluge._rpcapi.</tt><tt class="descname">RpcApi</tt><a class="headerlink" href="#deluge._rpcapi.RpcApi" title="Permalink to this definition"></a></dt>
<dd><dl class="class">
<dt id="deluge._rpcapi.RpcApi.core">
<em class="property">
class </em><tt class="descname">core</tt><a class="headerlink" href="#deluge._rpcapi.RpcApi.core" title="Permalink to this definition"></a></dt>
<dd><p>Methods available in core</p>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.add_torrent_file">
<tt class="descname">add_torrent_file</tt><big>(</big><em>filename</em>, <em>filedump</em>, <em>options</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.add_torrent_file" title="Permalink to this definition"></a></dt>
<dd><p>Adds a torrent file to the session.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>filename</em> &#8211; str, the filename of the torrent</li>
<li><em>filedump</em> &#8211; str, a base64 encoded string of the torrent file contents</li>
<li><em>options</em> &#8211; dict, the options to apply to the torrent on add</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the torrent_id as a str or None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.add_torrent_magnet">
<tt class="descname">add_torrent_magnet</tt><big>(</big><em>uri</em>, <em>options</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.add_torrent_magnet" title="Permalink to this definition"></a></dt>
<dd><p>Adds a torrent from a magnet link.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>uri</em> &#8211; str, the magnet link</li>
<li><em>options</em> &#8211; dict, the options to apply to the torrent on add</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.add_torrent_url">
<tt class="descname">add_torrent_url</tt><big>(</big><em>url</em>, <em>options</em>, <em>headers=None</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.add_torrent_url" title="Permalink to this definition"></a></dt>
<dd><p>Adds a torrent from a url. Deluge will attempt to fetch the torrent
from url prior to adding it to the session.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><em>url</em> &#8211; str, the url pointing to the torrent file</li>
<li><em>options</em> &#8211; dict, the options to apply to the torrent on add</li>
<li><em>headers</em> &#8211; dict, any optional headers to send</li>
</ul>
</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the torrent_id as a str or None, if calling locally, then it
will return a Deferred that fires once the torrent has been added</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.force_recheck">
<tt class="descname">force_recheck</tt><big>(</big><em>torrent_ids</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.force_recheck" title="Permalink to this definition"></a></dt>
<dd>Forces a data recheck on torrent_ids</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_available_plugins">
<tt class="descname">get_available_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_available_plugins" title="Permalink to this definition"></a></dt>
<dd>Returns a list of plugins available in the core</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_cache_status">
<tt class="descname">get_cache_status</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_cache_status" title="Permalink to this definition"></a></dt>
<dd><p>Returns a dictionary of the session&#8217;s cache status.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a dict of the cache status</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_config">
<tt class="descname">get_config</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_config" title="Permalink to this definition"></a></dt>
<dd>Get all the preferences as a dictionary</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_config_value">
<tt class="descname">get_config_value</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_config_value" title="Permalink to this definition"></a></dt>
<dd>Get the config value for key</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_config_values">
<tt class="descname">get_config_values</tt><big>(</big><em>keys</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_config_values" title="Permalink to this definition"></a></dt>
<dd>Get the config values for the entered keys</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_dht_nodes">
<tt class="descname">get_dht_nodes</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_dht_nodes" title="Permalink to this definition"></a></dt>
<dd>Returns the number of dht nodes</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_download_rate">
<tt class="descname">get_download_rate</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_download_rate" title="Permalink to this definition"></a></dt>
<dd>Returns the payload download rate</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_enabled_plugins">
<tt class="descname">get_enabled_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_enabled_plugins" title="Permalink to this definition"></a></dt>
<dd>Returns a list of enabled plugins in the core</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_filter_tree">
<tt class="descname">get_filter_tree</tt><big>(</big><em>show_zero_hits=True</em>, <em>hide_cat=None</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_filter_tree" title="Permalink to this definition"></a></dt>
<dd>returns {field: [(value,count)] }
for use in sidebar(s)</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_health">
<tt class="descname">get_health</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_health" title="Permalink to this definition"></a></dt>
<dd>Returns True if we have established incoming connections</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_listen_port">
<tt class="descname">get_listen_port</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_listen_port" title="Permalink to this definition"></a></dt>
<dd>Returns the active listen port</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_num_connections">
<tt class="descname">get_num_connections</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_num_connections" title="Permalink to this definition"></a></dt>
<dd>Returns the current number of connections</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_path_size">
<tt class="descname">get_path_size</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_path_size" title="Permalink to this definition"></a></dt>
<dd>Returns the size of the file or folder &#8216;path&#8217; and -1 if the path is
unaccessible (non-existent or insufficient privs)</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_session_state">
<tt class="descname">get_session_state</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_session_state" title="Permalink to this definition"></a></dt>
<dd>Returns a list of torrent_ids in the session.</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_session_status">
<tt class="descname">get_session_status</tt><big>(</big><em>keys</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_session_status" title="Permalink to this definition"></a></dt>
<dd><p>Gets the session status values for &#8216;keys&#8217;</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>keys</em> &#8211; list of strings, the keys for which we want values</td>
</tr>
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">a dictionary of {key: value, ...}</td>
</tr>
<tr class="field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_stats">
<tt class="descname">get_stats</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_stats" title="Permalink to this definition"></a></dt>
<dd>document me!!!</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_status_keys">
<tt class="descname">get_status_keys</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_status_keys" title="Permalink to this definition"></a></dt>
<dd>returns all possible keys for the keys argument in get_torrent(s)_status.</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_torrents_status">
<tt class="descname">get_torrents_status</tt><big>(</big><em>filter_dict</em>, <em>keys</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_torrents_status" title="Permalink to this definition"></a></dt>
<dd>returns all torrents , optionally filtered by filter_dict.</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.get_upload_rate">
<tt class="descname">get_upload_rate</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.get_upload_rate" title="Permalink to this definition"></a></dt>
<dd>Returns the payload upload rate</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.pause_all_torrents">
<tt class="descname">pause_all_torrents</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.pause_all_torrents" title="Permalink to this definition"></a></dt>
<dd>Pause all torrents in the session</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.rename_files">
<tt class="descname">rename_files</tt><big>(</big><em>torrent_id</em>, <em>filenames</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.rename_files" title="Permalink to this definition"></a></dt>
<dd>Renames files in &#8216;torrent_id&#8217;. The &#8216;filenames&#8217; parameter should be a
list of (index, filename) pairs.</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.rename_folder">
<tt class="descname">rename_folder</tt><big>(</big><em>torrent_id</em>, <em>folder</em>, <em>new_folder</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.rename_folder" title="Permalink to this definition"></a></dt>
<dd>Renames the &#8216;folder&#8217; to &#8216;new_folder&#8217; in &#8216;torrent_id&#8217;.</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.rescan_plugins">
<tt class="descname">rescan_plugins</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.rescan_plugins" title="Permalink to this definition"></a></dt>
<dd>Rescans the plugin folders for new plugins</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.resume_all_torrents">
<tt class="descname">resume_all_torrents</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.resume_all_torrents" title="Permalink to this definition"></a></dt>
<dd>Resume all torrents in the session</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_config">
<tt class="descname">set_config</tt><big>(</big><em>config</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_config" title="Permalink to this definition"></a></dt>
<dd>Set the config with values from dictionary</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_auto_managed">
<tt class="descname">set_torrent_auto_managed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_auto_managed" title="Permalink to this definition"></a></dt>
<dd>Sets the auto managed flag for queueing purposes</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_file_priorities">
<tt class="descname">set_torrent_file_priorities</tt><big>(</big><em>torrent_id</em>, <em>priorities</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_file_priorities" title="Permalink to this definition"></a></dt>
<dd>Sets a torrents file priorities</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_max_connections">
<tt class="descname">set_torrent_max_connections</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_max_connections" title="Permalink to this definition"></a></dt>
<dd>Sets a torrents max number of connections</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_max_download_speed">
<tt class="descname">set_torrent_max_download_speed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_max_download_speed" title="Permalink to this definition"></a></dt>
<dd>Sets a torrents max download speed</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_max_upload_slots">
<tt class="descname">set_torrent_max_upload_slots</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_max_upload_slots" title="Permalink to this definition"></a></dt>
<dd>Sets a torrents max number of upload slots</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_max_upload_speed">
<tt class="descname">set_torrent_max_upload_speed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_max_upload_speed" title="Permalink to this definition"></a></dt>
<dd>Sets a torrents max upload speed</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_move_completed">
<tt class="descname">set_torrent_move_completed</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_move_completed" title="Permalink to this definition"></a></dt>
<dd>Sets the torrent to be moved when completed</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_move_completed_path">
<tt class="descname">set_torrent_move_completed_path</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_move_completed_path" title="Permalink to this definition"></a></dt>
<dd>Sets the path for the torrent to be moved when completed</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_options">
<tt class="descname">set_torrent_options</tt><big>(</big><em>torrent_ids</em>, <em>options</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_options" title="Permalink to this definition"></a></dt>
<dd>Sets the torrent options for torrent_ids</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_prioritize_first_last">
<tt class="descname">set_torrent_prioritize_first_last</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_prioritize_first_last" title="Permalink to this definition"></a></dt>
<dd>Sets a higher priority to the first and last pieces</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_remove_at_ratio">
<tt class="descname">set_torrent_remove_at_ratio</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_remove_at_ratio" title="Permalink to this definition"></a></dt>
<dd>Sets the torrent to be removed at &#8216;stop_ratio&#8217;</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_stop_at_ratio">
<tt class="descname">set_torrent_stop_at_ratio</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_stop_at_ratio" title="Permalink to this definition"></a></dt>
<dd>Sets the torrent to stop at &#8216;stop_ratio&#8217;</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_stop_ratio">
<tt class="descname">set_torrent_stop_ratio</tt><big>(</big><em>torrent_id</em>, <em>value</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_stop_ratio" title="Permalink to this definition"></a></dt>
<dd>Sets the ratio when to stop a torrent if &#8216;stop_at_ratio&#8217; is set</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.set_torrent_trackers">
<tt class="descname">set_torrent_trackers</tt><big>(</big><em>torrent_id</em>, <em>trackers</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.set_torrent_trackers" title="Permalink to this definition"></a></dt>
<dd>Sets a torrents tracker list. trackers will be [{&#8220;url&#8221;, &#8220;tier&#8221;}]</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.test_listen_port">
<tt class="descname">test_listen_port</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.test_listen_port" title="Permalink to this definition"></a></dt>
<dd>Checks if active port is open</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.core.upload_plugin">
<tt class="descname">upload_plugin</tt><big>(</big><em>filename</em>, <em>plugin_data</em><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.core.upload_plugin" title="Permalink to this definition"></a></dt>
<dd>This method is used to upload new plugins to the daemon. It is used
when connecting to the daemon remotely and installing a new plugin on
the client side. &#8216;plugin_data&#8217; is a xmlrpc.Binary object of the file data,
ie, plugin_file.read()</dd></dl>
</dd></dl>
<dl class="class">
<dt id="deluge._rpcapi.RpcApi.daemon">
<em class="property">
class </em><tt class="descclassname">RpcApi.</tt><tt class="descname">daemon</tt><a class="headerlink" href="#deluge._rpcapi.RpcApi.daemon" title="Permalink to this definition"></a></dt>
<dd><p>Methods available in daemon</p>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.daemon.get_method_list">
<tt class="descname">get_method_list</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.daemon.get_method_list" title="Permalink to this definition"></a></dt>
<dd>Returns a list of the exported methods.</dd></dl>
<dl class="method">
<dt id="deluge._rpcapi.RpcApi.daemon.info">
<tt class="descname">info</tt><big>(</big><big>)</big><a class="headerlink" href="#deluge._rpcapi.RpcApi.daemon.info" title="Permalink to this definition"></a></dt>
<dd><p>Returns some info from the daemon.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">str, the version number</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</dd></dl>
</div>
</div>

84
docs/build/html/genindex.html vendored
View file

@ -43,7 +43,7 @@
<h1 id="index">Index</h1>
<a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#W"><strong>W</strong></a>
<a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#W"><strong>W</strong></a>
<hr />
@ -60,8 +60,11 @@
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.add_torrent_file">add_torrent_file() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.add_torrent_magnet">add_torrent_magnet() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.add_torrent_url">add_torrent_url() (deluge._rpcapi.RpcApi.core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="modules/config.html#deluge.config.Config.apply_all">apply_all() (deluge.config.Config method)</a></dt>
<dt><a href="modules/config.html#deluge.config.Config.apply_set_functions">apply_set_functions() (deluge.config.Config method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="modules/config.html#deluge.config.Config.apply_set_functions">apply_set_functions() (deluge.config.Config method)</a></dt>
</dl></td></tr></table>
<h2 id="C">C</h2>
@ -88,9 +91,10 @@
<dt><a href="modules/common.html#deluge.common.fdate">fdate() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.fetch_url">fetch_url() (in module deluge.common)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.force_recheck">force_recheck() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="modules/common.html#deluge.common.fpcnt">fpcnt() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.fpeer">fpeer() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.free_space">free_space() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="modules/common.html#deluge.common.fpeer">fpeer() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="modules/common.html#deluge.common.free_space">free_space() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.fsize">fsize() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.fspeed">fspeed() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.ftime">ftime() (in module deluge.common)</a></dt>
@ -100,12 +104,34 @@
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_available_plugins">get_available_plugins() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_cache_status">get_cache_status() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_config">get_config() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_config_value">get_config_value() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_config_values">get_config_values() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="modules/common.html#deluge.common.get_default_config_dir">get_default_config_dir() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.get_default_download_dir">get_default_download_dir() (in module deluge.common)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_dht_nodes">get_dht_nodes() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_download_rate">get_download_rate() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_enabled_plugins">get_enabled_plugins() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_filter_tree">get_filter_tree() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_health">get_health() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="modules/config.html#deluge.config.Config.get_item">get_item() (deluge.config.Config method)</a></dt>
<dt><a href="modules/common.html#deluge.common.get_path_size">get_path_size() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_listen_port">get_listen_port() (deluge._rpcapi.RpcApi.core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.daemon.get_method_list">get_method_list() (deluge._rpcapi.RpcApi.daemon method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_num_connections">get_num_connections() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_path_size">get_path_size() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dd><dl>
<dt><a href="modules/common.html#deluge.common.get_path_size">(in module deluge.common)</a></dt>
</dl></dd>
<dt><a href="modules/common.html#deluge.common.get_pixmap">get_pixmap() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.get_revision">get_revision() (in module deluge.common)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_session_state">get_session_state() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_session_status">get_session_status() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_stats">get_stats() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_status_keys">get_status_keys() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_torrents_status">get_torrents_status() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.get_upload_rate">get_upload_rate() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="modules/common.html#deluge.common.get_version">get_version() (in module deluge.common)</a></dt>
</dl></td></tr></table>
@ -113,6 +139,7 @@
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.daemon.info">info() (deluge._rpcapi.RpcApi.daemon method)</a></dt>
<dt><a href="modules/common.html#deluge.common.is_ip">is_ip() (in module deluge.common)</a></dt>
<dt><a href="modules/common.html#deluge.common.is_magnet">is_magnet() (in module deluge.common)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="modules/common.html#deluge.common.is_url">is_url() (in module deluge.common)</a></dt>
@ -134,12 +161,26 @@
<dt><a href="modules/common.html#deluge.common.osx_check">osx_check() (in module deluge.common)</a></dt>
</dl></td></tr></table>
<h2 id="P">P</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.pause_all_torrents">pause_all_torrents() (deluge._rpcapi.RpcApi.core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="R">R</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="modules/config.html#deluge.config.Config.register_change_callback">register_change_callback() (deluge.config.Config method)</a></dt>
<dt><a href="modules/config.html#deluge.config.Config.register_set_function">register_set_function() (deluge.config.Config method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="modules/config.html#deluge.config.Config.register_set_function">register_set_function() (deluge.config.Config method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.rename_files">rename_files() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.rename_folder">rename_folder() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.rescan_plugins">rescan_plugins() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.resume_all_torrents">resume_all_torrents() (deluge._rpcapi.RpcApi.core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi">RpcApi (class in deluge._rpcapi)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core">RpcApi.core (class in deluge._rpcapi)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.daemon">RpcApi.daemon (class in deluge._rpcapi)</a></dt>
<dt><a href="modules/config.html#deluge.config.Config.run_converter">run_converter() (deluge.config.Config method)</a></dt>
</dl></td></tr></table>
@ -148,7 +189,36 @@
<dl>
<dt><a href="modules/config.html#deluge.config.Config.save">save() (deluge.config.Config method)</a></dt>
<dt><a href="modules/config.html#deluge.config.Config.set_item">set_item() (deluge.config.Config method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_config">set_config() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="modules/config.html#deluge.config.Config.set_item">set_item() (deluge.config.Config method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_auto_managed">set_torrent_auto_managed() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_file_priorities">set_torrent_file_priorities() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_max_connections">set_torrent_max_connections() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_max_download_speed">set_torrent_max_download_speed() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_max_upload_slots">set_torrent_max_upload_slots() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_max_upload_speed">set_torrent_max_upload_speed() (deluge._rpcapi.RpcApi.core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_move_completed">set_torrent_move_completed() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_move_completed_path">set_torrent_move_completed_path() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_options">set_torrent_options() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_prioritize_first_last">set_torrent_prioritize_first_last() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_remove_at_ratio">set_torrent_remove_at_ratio() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_stop_at_ratio">set_torrent_stop_at_ratio() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_stop_ratio">set_torrent_stop_ratio() (deluge._rpcapi.RpcApi.core method)</a></dt>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.set_torrent_trackers">set_torrent_trackers() (deluge._rpcapi.RpcApi.core method)</a></dt>
</dl></td></tr></table>
<h2 id="T">T</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.test_listen_port">test_listen_port() (deluge._rpcapi.RpcApi.core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="U">U</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="core/rpc.html#deluge._rpcapi.RpcApi.core.upload_plugin">upload_plugin() (deluge._rpcapi.RpcApi.core method)</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
<h2 id="V">V</h2>

106
docs/build/html/objects.inv vendored
View file

@ -3,40 +3,90 @@
# Version: 1.2.0-dev
deluge.config mod modules/config.html
deluge.common mod modules/common.html
deluge.config.Config.apply_all method modules/config.html
deluge.config.Config.__getitem__ method modules/config.html
deluge.config.Config.__setitem__ method modules/config.html
deluge.config.Config class modules/config.html
deluge.common.is_ip function modules/common.html
deluge.config.Config.get_item method modules/config.html
deluge.common.fsize function modules/common.html
deluge.common.ftime function modules/common.html
deluge.common.free_space function modules/common.html
deluge.config.Config.config_file attribute modules/config.html
deluge.common.open_file function modules/common.html
deluge.common.get_default_config_dir function modules/common.html
deluge.common.open_url_in_browser function modules/common.html
deluge.common.get_path_size function modules/common.html
deluge.config.Config.register_set_function method modules/config.html
deluge.common.is_url function modules/common.html
deluge.common.fpcnt function modules/common.html
deluge.common.fspeed function modules/common.html
deluge.config.Config.run_converter method modules/config.html
deluge.config.Config.register_change_callback method modules/config.html
deluge.common.get_version function modules/common.html
deluge._rpcapi.RpcApi.core.set_torrent_stop_at_ratio method core/rpc.html
deluge._rpcapi.RpcApi.core.get_config_values method core/rpc.html
deluge._rpcapi.RpcApi.core.get_status_keys method core/rpc.html
deluge._rpcapi.RpcApi.core.get_torrents_status method core/rpc.html
deluge._rpcapi.RpcApi.core.set_torrent_max_download_speed method core/rpc.html
deluge._rpcapi.RpcApi.core.set_torrent_prioritize_first_last method core/rpc.html
deluge.config.Config.config attribute modules/config.html
deluge.config.Config.apply_set_functions method modules/config.html
deluge.common.get_revision function modules/common.html
deluge.common.fdate function modules/common.html
deluge.common.get_pixmap function modules/common.html
deluge._rpcapi.RpcApi.daemon.get_method_list method core/rpc.html
deluge._rpcapi.RpcApi.core.rescan_plugins method core/rpc.html
deluge.common.fpeer function modules/common.html
deluge.common.is_magnet function modules/common.html
deluge.common.fetch_url function modules/common.html
deluge.config.Config.load method modules/config.html
deluge.common.create_magnet_uri function modules/common.html
deluge.common.vista_check function modules/common.html
deluge._rpcapi.RpcApi.core.add_torrent_magnet method core/rpc.html
deluge.common.is_ip function modules/common.html
deluge._rpcapi.RpcApi.core.rename_files method core/rpc.html
deluge._rpcapi.RpcApi.core.get_session_status method core/rpc.html
deluge._rpcapi.RpcApi.core.test_listen_port method core/rpc.html
deluge.common.ftime function modules/common.html
deluge.common.get_default_config_dir function modules/common.html
deluge._rpcapi.RpcApi.core.get_dht_nodes method core/rpc.html
deluge._rpcapi.RpcApi.core.set_torrent_auto_managed method core/rpc.html
deluge.common.fpcnt function modules/common.html
deluge._rpcapi.RpcApi.core.set_torrent_max_connections method core/rpc.html
deluge.common.fspeed function modules/common.html
deluge._rpcapi.RpcApi.core.get_cache_status method core/rpc.html
deluge._rpcapi.RpcApi.core.set_config method core/rpc.html
deluge._rpcapi.RpcApi.daemon.info method core/rpc.html
deluge._rpcapi.RpcApi.core.force_recheck method core/rpc.html
deluge.common.get_version function modules/common.html
deluge._rpcapi.RpcApi.core.get_stats method core/rpc.html
deluge._rpcapi.RpcApi.core.set_torrent_move_completed_path method core/rpc.html
deluge._rpcapi.RpcApi.core.get_health method core/rpc.html
deluge.common.fdate function modules/common.html
deluge._rpcapi.RpcApi.core.set_torrent_remove_at_ratio method core/rpc.html
deluge._rpcapi.RpcApi.core.get_download_rate method core/rpc.html
deluge._rpcapi.RpcApi.core.rename_folder method core/rpc.html
deluge.common.get_default_download_dir function modules/common.html
deluge._rpcapi.RpcApi.daemon class core/rpc.html
deluge._rpcapi.RpcApi.core.set_torrent_options method core/rpc.html
deluge._rpcapi.RpcApi.core.get_config_value method core/rpc.html
deluge._rpcapi.RpcApi.core.get_num_connections method core/rpc.html
deluge.config.Config.apply_all method modules/config.html
deluge._rpcapi.RpcApi.core.get_path_size method core/rpc.html
deluge.config.Config.__setitem__ method modules/config.html
deluge._rpcapi.RpcApi.core.pause_all_torrents method core/rpc.html
deluge.config.Config.get_item method modules/config.html
deluge._rpcapi.RpcApi.core.add_torrent_file method core/rpc.html
deluge.config.Config.register_set_function method modules/config.html
deluge.common.free_space function modules/common.html
deluge.common.open_file function modules/common.html
deluge._rpcapi.RpcApi.core.get_listen_port method core/rpc.html
deluge.common.is_url function modules/common.html
deluge._rpcapi.RpcApi.core.get_enabled_plugins method core/rpc.html
deluge.config.Config.register_change_callback method modules/config.html
deluge._rpcapi.RpcApi.core.get_upload_rate method core/rpc.html
deluge.config.Config.apply_set_functions method modules/config.html
deluge._rpcapi.RpcApi.core.set_torrent_max_upload_speed method core/rpc.html
deluge.common.is_magnet function modules/common.html
deluge._rpcapi.RpcApi.core.get_available_plugins method core/rpc.html
deluge._rpcapi.RpcApi.core.get_session_state method core/rpc.html
deluge.common.get_path_size function modules/common.html
deluge._rpcapi.RpcApi.core.set_torrent_stop_ratio method core/rpc.html
deluge._rpcapi.RpcApi.core class core/rpc.html
deluge.common.osx_check function modules/common.html
deluge.config.Config.save method modules/config.html
deluge._rpcapi.RpcApi.core.get_filter_tree method core/rpc.html
deluge._rpcapi.RpcApi.core.upload_plugin method core/rpc.html
deluge._rpcapi.RpcApi.core.resume_all_torrents method core/rpc.html
deluge.common.fsize function modules/common.html
deluge._rpcapi.RpcApi.core.set_torrent_file_priorities method core/rpc.html
deluge._rpcapi.RpcApi class core/rpc.html
deluge.config.Config.config_file attribute modules/config.html
deluge.common.open_url_in_browser function modules/common.html
deluge.config.Config.run_converter method modules/config.html
deluge._rpcapi.RpcApi.core.set_torrent_move_completed method core/rpc.html
deluge.common.get_revision function modules/common.html
deluge._rpcapi.RpcApi.core.get_config method core/rpc.html
deluge.common.get_pixmap function modules/common.html
deluge.common.fetch_url function modules/common.html
deluge._rpcapi.RpcApi.core.set_torrent_max_upload_slots method core/rpc.html
deluge.config.Config class modules/config.html
deluge.config.Config.set_item method modules/config.html
deluge.common.windows_check function modules/common.html
deluge.common.vista_check function modules/common.html
deluge.common.get_default_download_dir function modules/common.html
deluge._rpcapi.RpcApi.core.set_torrent_trackers method core/rpc.html
deluge._rpcapi.RpcApi.core.add_torrent_url method core/rpc.html

2
docs/build/html/searchindex.js vendored
View file

File diff suppressed because one or more lines are too long

2
docs/source/conf.py
View file

@ -36,7 +36,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General substitutions.
project = 'deluge'
project = 'Deluge'
copyright = '2008, Andrew Resch'
# The default replacements for |version| and |release|, also used in various

6
docs/source/core/index.rst
View file

@ -1,2 +1,6 @@
The Deluge Core
===============
===============
.. toctree::
DelugeRPC <rpc>

105
docs/source/core/rpc.rst Normal file
View file

@ -0,0 +1,105 @@
Deluge RPC
==========
---------------
Message Formats
---------------
DelugeRPC is a protocol used for daemon/client communication. There are four
types of messages involved in the protocol: RPC Request, RPC Response,
RPC Error and Event. All messages are zlib compressed rencoded strings and
their data formats are detailed below.
"""""""""""
RPC Request
"""""""""""
This message is created and sent by the client to the server requesting that a
remote method be called. Multiple requests can be bundled in a list.
**[[request_id, method, [args], {kwargs}], ...]**
**request_id** (int)
An integer determined by the client that is used in replies from the server.
This is used to ensure the client knows which request the data is in
response to. Another alternative would be to respond in the same order the
requests come in, but this could cause lag if an earlier request takes
longer to process.
**method** (str)
The name of the remote method to call. This name can be in dotted format to
call other objects or plugins methods.
**args** (list)
The arguments to call the method with.
**kwargs** (dict)
The keyword arguments to call the method with.
""""""""""""
RPC Response
""""""""""""
This message is created and sent in response to a RPC Request from a client. It
will hold the return value of the requested method call. In the case of an
error, a RPC Error message will be sent instead.
**[message_type, request_id, [return_value]]**
**message_type** (int)
This will be a RPC_RESPONSE type id. This is used on the client side to
determine what kind of message is being received from the daemon.
**request_id** (int)
The request_id is the same as the one sent by the client in the initial
request. It used on the client side to determine what message this is in
response to.
**return_value** (list)
The return value of the method call.
"""""""""
RPC Error
"""""""""
This message is created in response to an error generated while processing a
RPC Request and will serve as a replacement for a RPC Response message.
**[message_type, request_id, exception_type, exception_msg, traceback]**
**message_type** (int)
This will be a RPC_ERROR type id.
**request_id** (int)
The request_id is the same as the one sent by the client in the initial
request.
**exception_type** (str)
The type of exception raised.
**exception_msg** (str)
The message as to why the exception was raised.
**traceback** (str)
The traceback of the generated exception.
"""""
Event
"""""
This message is created by the daemon and sent to the clients without being in
response to a RPC Request. Events are generally sent for changes in the
daemon's state that the clients need to be made aware of.
**[message_type, event_name, data]**
**message_type** (int)
This will be a RPC_EVENT type id.
**event_name** (str)
This is the name of the event being emitted by the daemon.
**data** (list)
Additional data to be sent with the event. This is dependent upon the event
being emitted.
----------
Remote API
----------
.. autoclass:: deluge._rpcapi.RpcApi
:members: