Changes between Version 45 and Version 46 of archive/Development/UiClient


Ignore:
Timestamp:
08/29/2008 05:43:27 PM (16 years ago)
Author:
mvoncken
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • archive/Development/UiClient

    v45 v46  
    124124'''add_torrent_file(torrent_files, torrent_options): ''' 
    125125 
     126{{{ 
    126127Adds torrent files to the core 
    127128Expects a list of torrent files 
    128129A list of torrent_option dictionaries in the same order of torrent_files 
     130}}} 
    129131 
    130132'''add_torrent_file_binary(filename, fdump, options): ''' 
    131133 
     134{{{ 
    132135Core-wrapper. 
    133136Adds 1 torrent file to the core. 
    134137Expects fdump as a bytestring (== result of f.read()). 
     138}}} 
    135139 
    136140'''add_torrent_url(url, save_path, options): ''' 
    137141 
    138  
     142{{{ 
     143 
     144}}} 
    139145 
    140146'''block_ip_range(range): ''' 
    141147 
     148{{{ 
    142149Block an ip range 
     150}}} 
    143151 
    144152'''deregister_client(): ''' 
    145153 
     154{{{ 
    146155De-registers a client with the signal manager. 
     156}}} 
    147157 
    148158'''disable_plugin(plugin): ''' 
    149159 
    150  
     160{{{ 
     161 
     162}}} 
    151163 
    152164'''enable_plugin(plugin): ''' 
    153165 
    154  
     166{{{ 
     167 
     168}}} 
    155169 
    156170'''force_reannounce(torrent_ids): ''' 
    157171 
    158  
     172{{{ 
     173 
     174}}} 
    159175 
    160176'''force_recheck(torrent_ids): ''' 
    161177 
     178{{{ 
    162179Forces a data recheck on torrent_ids 
     180}}} 
    163181 
    164182'''get_available_plugins([callback]): ''' 
    165183 
     184{{{ 
    166185Returns a list of plugins available in the core 
     186}}} 
    167187 
    168188'''get_config([callback]): ''' 
    169189 
     190{{{ 
    170191Get all the preferences as a dictionary 
     192}}} 
    171193 
    172194'''get_config_value([callback], key): ''' 
    173195 
     196{{{ 
    174197Get the config value for key 
     198}}} 
    175199 
    176200'''get_dht_nodes([callback]): ''' 
    177201 
     202{{{ 
    178203Returns the number of dht nodes 
     204}}} 
    179205 
    180206'''get_download_rate([callback]): ''' 
    181207 
     208{{{ 
    182209Returns the payload download rate 
     210}}} 
    183211 
    184212'''get_enabled_plugins([callback]): ''' 
    185213 
     214{{{ 
    186215Returns a list of enabled plugins in the core 
     216}}} 
    187217 
    188218'''get_filter_tree([callback]): ''' 
    189219 
     220{{{ 
    190221returns {field: [(value,count)] } 
    191222for use in sidebar(s) 
     223}}} 
    192224 
    193225'''get_health([callback]): ''' 
    194226 
     227{{{ 
    195228Returns True if we have established incoming connections 
     229}}} 
    196230 
    197231'''get_listen_port([callback]): ''' 
    198232 
     233{{{ 
    199234Returns the active listen port 
     235}}} 
    200236 
    201237'''get_num_connections([callback]): ''' 
    202238 
     239{{{ 
    203240Returns the current number of connections 
     241}}} 
    204242 
    205243'''get_session_state([callback]): ''' 
    206244 
     245{{{ 
    207246Returns a list of torrent_ids in the session. 
     247}}} 
    208248 
    209249'''get_status_keys([callback]): ''' 
    210250 
     251{{{ 
    211252returns all possible keys for the keys argument in get_torrent(s)_status. 
     253}}} 
    212254 
    213255'''get_torrent_status([callback], torrent_id, keys): ''' 
    214256 
    215  
     257{{{ 
     258 
     259}}} 
    216260 
    217261'''get_torrents_status([callback], filter_dict, keys): ''' 
    218262 
     263{{{ 
    219264returns all torrents , optionally filtered by filter_dict. 
     265}}} 
    220266 
    221267'''get_upload_rate([callback]): ''' 
    222268 
     269{{{ 
    223270Returns the payload upload rate 
     271}}} 
    224272 
    225273'''move_storage(torrent_ids, dest): ''' 
    226274 
    227  
     275{{{ 
     276 
     277}}} 
    228278 
    229279'''pause_all_torrents(): ''' 
    230280 
     281{{{ 
    231282Pause all torrents in the session 
     283}}} 
    232284 
    233285'''pause_torrent(torrent_ids): ''' 
    234286 
    235  
     287{{{ 
     288 
     289}}} 
    236290 
    237291'''ping([callback]): ''' 
    238292 
     293{{{ 
    239294A method to see if the core is running 
     295}}} 
    240296 
    241297'''queue_bottom([callback], torrent_ids): ''' 
    242298 
    243  
     299{{{ 
     300 
     301}}} 
    244302 
    245303'''queue_down([callback], torrent_ids): ''' 
    246304 
    247  
     305{{{ 
     306 
     307}}} 
    248308 
    249309'''queue_top([callback], torrent_ids): ''' 
    250310 
     311{{{ 
    251312## Queueing functions ## 
     313}}} 
    252314 
    253315'''queue_up([callback], torrent_ids): ''' 
    254316 
    255  
     317{{{ 
     318 
     319}}} 
    256320 
    257321'''register_client(port): ''' 
    258322 
     323{{{ 
    259324Registers a client with the signal manager so that signals are 
    260325sent to it. 
     326}}} 
    261327 
    262328'''remove_torrent(torrent_ids, remove_torrent, remove_data): ''' 
    263329 
    264  
     330{{{ 
     331 
     332}}} 
    265333 
    266334'''reset_ip_filter([callback]): ''' 
    267335 
     336{{{ 
    268337Clears the ip filter 
     338}}} 
    269339 
    270340'''resume_all_torrents(): ''' 
    271341 
     342{{{ 
    272343Resume all torrents in the session 
     344}}} 
    273345 
    274346'''resume_torrent(torrent_ids): ''' 
    275347 
    276  
     348{{{ 
     349 
     350}}} 
    277351 
    278352'''save_state([callback]): ''' 
    279353 
     354{{{ 
    280355Save the current session state to file. 
     356}}} 
    281357 
    282358'''set_config(config): ''' 
    283359 
     360{{{ 
    284361Set the config with values from dictionary 
     362}}} 
    285363 
    286364'''set_torrent_auto_managed(torrent_id, value): ''' 
    287365 
     366{{{ 
    288367Sets the auto managed flag for queueing purposes 
     368}}} 
    289369 
    290370'''set_torrent_file_priorities(torrent_id, priorities): ''' 
    291371 
     372{{{ 
    292373Sets a torrents file priorities 
     374}}} 
    293375 
    294376'''set_torrent_max_connections(torrent_id, value): ''' 
    295377 
     378{{{ 
    296379Sets a torrents max number of connections 
     380}}} 
    297381 
    298382'''set_torrent_max_download_speed(torrent_id, value): ''' 
    299383 
     384{{{ 
    300385Sets a torrents max download speed 
     386}}} 
    301387 
    302388'''set_torrent_max_upload_slots(torrent_id, value): ''' 
    303389 
     390{{{ 
    304391Sets a torrents max number of upload slots 
     392}}} 
    305393 
    306394'''set_torrent_max_upload_speed(torrent_id, value): ''' 
    307395 
     396{{{ 
    308397Sets a torrents max upload speed 
     398}}} 
    309399 
    310400'''set_torrent_move_on_completed(torrent_id, value): ''' 
    311401 
     402{{{ 
    312403Sets the torrent to be moved when completed 
     404}}} 
    313405 
    314406'''set_torrent_move_on_completed_path(torrent_id, value): ''' 
    315407 
     408{{{ 
    316409Sets the path for the torrent to be moved when completed 
     410}}} 
     411 
     412'''set_torrent_options([callback], torrent_ids, options): ''' 
     413 
     414{{{ 
     415Sets the torrent options for torrent_ids 
     416}}} 
    317417 
    318418'''set_torrent_prioritize_first_last(torrent_id, value): ''' 
    319419 
     420{{{ 
    320421Sets a higher priority to the first and last pieces 
     422}}} 
    321423 
    322424'''set_torrent_remove_at_ratio(torrent_id, value): ''' 
    323425 
     426{{{ 
    324427Sets the torrent to be removed at 'stop_ratio' 
     428}}} 
    325429 
    326430'''set_torrent_stop_at_ratio(torrent_id, value): ''' 
    327431 
     432{{{ 
    328433Sets the torrent to stop at 'stop_ratio' 
     434}}} 
    329435 
    330436'''set_torrent_stop_ratio(torrent_id, value): ''' 
    331437 
     438{{{ 
    332439Sets the ratio when to stop a torrent if 'stop_at_ratio' is set 
     440}}} 
    333441 
    334442'''set_torrent_trackers(torrent_id, trackers): ''' 
    335443 
     444{{{ 
    336445Sets a torrents tracker list.  trackers will be [{"url", "tier"}] 
     446}}} 
    337447 
    338448'''shutdown([callback]): ''' 
    339449 
     450{{{ 
    340451Shutdown the core daemon 
     452}}} 
     453 
    341454 
    342455= Notes =