AMuleWeb PHP - Revision history

Woutermense: /* Return values */

2010-04-06T16:54:28Z

‎Return values

Woutermense: /* Return values */

2010-03-30T16:17:09Z

‎Return values

Woutermense: /* Return values */

2010-03-30T13:35:49Z

‎Return values

Woutermense: /* Return values */

2010-03-22T16:12:49Z

‎Return values

Woutermense: /* Return values */

2010-03-22T15:19:07Z

‎Return values

Woutermense: amule_load_vars udated

2010-03-22T15:17:08Z

amule_load_vars udated

Show changes

Woutermense: /* Functions */

2010-03-08T17:53:54Z

‎Functions

Woutermense: /* Functions */

2009-06-09T19:48:05Z

‎Functions

Woutermense: /* Functions */

2009-06-04T20:47:31Z

‎Functions

Woutermense: /* Functions */

2009-06-04T13:57:08Z

‎Functions

@@ Line 291: / Line 291: @@
 * When ''$command'' is "stats-graph", '''amule_load_vars''' returns images containing graphs of some of the stats. They are ...x... pixels. Their names are ...
 ** Download speed, upload speed, ed2k connections, kad connections.
-* When ''$command'' is "stats-tree", '''amule_load_vars''' returns an array containing the stats
+* When ''$command'' is "stats_tree", '''amule_load_vars''' returns an array containing the stats
 ===== Programming example =====

@@ Line 279: / Line 279: @@
 ** "size": File size in bytes.
 ** "sources": Number of found sources.
-** "present": (?)
+** "present": Whether file is already downloaded/downloading (boolean)
 * When ''$command'' is "servers", '''amule_load_vars''' returns an array containing the servers currently in the server list. The keys and values are:
 ** "name": Name of the server.

@@ Line 280: / Line 280: @@
 ** "sources": Number of found sources.
 ** "present": (?)
-* When ''$command'' is "searchresult", '''amule_load_vars''' returns an array containing the servers currently in the server list. The keys and values are:
+* When ''$command'' is "servers", '''amule_load_vars''' returns an array containing the servers currently in the server list. The keys and values are:
 ** "name": Name of the server.
 ** "desc": Description of the server.

@@ Line 234: / Line 234: @@
 * ''$command'': can be one of the following: "downloads", "uploads", "searchresult", "shared", "servers", "stats_graph", "stats_tree"
 ===== Return values =====
-* When ''$command'' is "downloads", '''amule_load_vars''' returns an array of the currently downloading files. The keys and values are:
+* When ''$command'' is "downloads", '''amule_load_vars''' returns an array containing the currently downloading files. The keys and values are:
 ** "name": Full name of the file with extension.
 ** "short_name": The full name trucated after some chars and ended with three periods.

@@ Line 241: / Line 241: @@
 ** "link": Full ed2k link, be aware: it included you ip as sources.
 ** "category": Id of the category of the file, where 0 = all, 1 = first category, etc... see '''amule_get_categories'''
-** "status": Indicates the status of the file, where 0 = ready, 1 = empty (?), 2 and 3 = hashing the file, 4 = an error occured, 5 = insufficient disk space, 6 = unknown, never happens, 7 = stopped or paused, 8 = completing (copying the file), 9 = download complete, 10 = allocating full disk space needed for the file. When status = 0, evaluate src_count_xfer, to determine whether the file is currently downloading. When status = 7, evaluate src_count to distinguish between stopped and paused. A stopped file has 0 sources. A file which has 0 known sources can also be paused but the effect is the same.
+** "status": Indicates the status of the file, where 0 = ready, 1 = empty (?), 2 and 3 = hashing the file, 4 = an error occured, 5 = insufficient disk space, 6 = unknown, never happens, 7 = stopped or paused, 8 = completing (copying the file), 9 = download complete, 10 = allocating full disk space needed for the file. When status = 0, evaluate src_count_xfer, to determine whether the file is currently downloading or waiting. When status = 7, evaluate src_count to distinguish between stopped and paused. A stopped file has 0 sources. A file which has 0 known sources can also be paused but the effect is the same.
 ** "size": File size in bytes.
 ** "size_done": Part of the file that is downloaded and not corrupted.
@@ Line 292: / Line 292: @@
 ** Download speed, upload speed, ed2k connections, kad connections.
 * When ''$command'' is "stats-tree", '''amule_load_vars''' returns an array containing the stats
 ===== Programming example =====
   $var = amule_load_vars($name_of_variable)

@@ Line 164: / Line 164: @@
 ===== Description =====
   array '''amule_get_options'''()
-Returns options and their values. Options are returned in form of an associative array, where keys are categories and values are associative arrays of name-value for each option.
+Returns options and their values.
 ===== Return values =====
-Returned keys are: "nick", "connection", "files", "webserver", "coretweaks".
+Returns an associative array with the keys: "nick", "connection", "files", "webserver", "coretweaks".
+* "nick": Your nickname on the ed2k network.
-Value of "connection" is an associative array with keys: "max_line_up_cap", "max_line_down_cap", "max_up_limit", "max_down_limit", "slot_alloc", "tcp_port", "udp_port", "udp_dis", "max_file_src", "max_conn_total", "autoconn_en", "reconn_en".
+* "connection": Value of "connection" is an associative array with the keys: "max_line_up_cap", "max_line_down_cap", "max_up_limit", "max_down_limit", "slot_alloc", "tcp_port", "udp_port", "udp_dis", "max_file_src", "max_conn_total", "autoconn_en", "reconn_en".
+** "max_line_up_cap": Network connection upload bandwidth in kB/s.
-Value of "files" is an associative array with keys: "ich_en", "aich_trust", "new_files_paused", "new_files_auto_dl_prio", "preview_prio", "new_files_auto_ul_prio", "upload_full_chunks", "first_last_chunks_prio", "start_next_paused", "resume_same_cat", "save_sources", "extract_metadata", "alloc_full", "check_free_space", "min_free_space".
+** "max_line_down_cap": Network connection download bandwidth in kB/s.
+** "max_up_limit": Upload bandwidth limit in kB/s.
-Value of "webserver" is an associative array with keys: "use_gzip", "autorefresh_time".
+** "max_down_limit": Download bandwidth limit in kB/s.
+** "slot_alloc": Allocated bandwidth per upload slot in kB/s.
-Value of "coretweaks" is an associative array with key: "max_conn_5sec".
+** "tcp_port": TCP port to use.
 ==== amule_set_options ====
-'''''amule_set_options($options_hash)''''': set [[aMule]] options. Receives hash in form returned by '''''amule_get_options()'''''
+===== Description =====
 ==== amule_do_search_download_cmd ====

@@ Line 162: / Line 162: @@
 ==== amule_get_options ====
-'''''amule_get_options()''''': return options and their values. Options are returned in form of hash, where keys are categories and values are hashes of name-value for each option.
+===== Description =====
-Returned keys are: '''nick, connection, files, webserver, coretweaks'''.
+Value of "connection" is an associative array with keys: "max_line_up_cap", "max_line_down_cap", "max_up_limit", "max_down_limit", "slot_alloc", "tcp_port", "udp_port", "udp_dis", "max_file_src", "max_conn_total", "autoconn_en", "reconn_en".
-Value of '''connection''' is a hash with keys: '''max_line_up_cap, max_line_down_cap, max_up_limit, max_down_limit, slot_alloc, tcp_port, udp_port, udp_dis, max_file_src, max_conn_total, autoconn_en, reconn_en'''.
+Value of "files" is an associative array with keys: "ich_en", "aich_trust", "new_files_paused", "new_files_auto_dl_prio", "preview_prio", "new_files_auto_ul_prio", "upload_full_chunks", "first_last_chunks_prio", "start_next_paused", "resume_same_cat", "save_sources", "extract_metadata", "alloc_full", "check_free_space", "min_free_space".
-Value of '''files''' is a hash with keys: '''ich_en, aich_trust, new_files_paused, new_files_auto_dl_prio, preview_prio, new_files_auto_ul_prio, upload_full_chunks, first_last_chunks_prio, start_next_paused, resume_same_cat, save_sources, extract_metadata, alloc_full, check_free_space, min_free_space'''.
+Value of "webserver" is an associative array with keys: "use_gzip", "autorefresh_time".
-Value of '''webserver''' is a hash with keys: '''use_gzip, autorefresh_time'''.
+Value of "coretweaks" is an associative array with key: "max_conn_5sec".
-−
-Value of '''coretweaks''' is a hash with key: '''max_conn_5sec'''.
 ==== amule_set_options ====

@@ Line 116: / Line 116: @@
 ==== amule_do_add_server_cmd ====
 ===== Description =====
-'''''amule_do_add_server_cmd($server_addr, $server_port, $server_name)''''': Used to add a [[server]] to the [[server list]].
+ void '''amule_do_add_server_cmd'''(string ''$server_addr'', string ''$server_port'', string ''$server_name'')
 ===== Parameters =====
 ==== amule_do_server_cmd ====
-'''''amule_do_server_cmd($server_ip, $server_port, $command)''''': Used to connect to or disconnect from a server or to remove a server. '''''$command''''' can be '''connect''', '''disconnect''' or '''remove'''.
+===== Description =====
 ==== amule_get_stats ====
-'''''amule_get_stats()''''': Used to query the status of aMule. Returns a hash with the keys: '''id, serv_addr, serv_name, serv_users, kad_connected, kad_firewalled, speed_up, speed_down, speed_limit_up, speed_limit_down'''.
+===== Description =====
 ==== amule_get_categories ====
-'''''amule_get_categories()''''': return list of valid categories in form of a associative array, the key is and index starting from 0 (= all), the value is the full name of the category ('all' is the 0-indexed, others may be "film", "Docs", etc...)
+===== Description =====
   $cat_list = amule_get_categories();
   foreach($cat_list as $key => $cat_string) {

@@ Line 93: / Line 93: @@
 ==== amule_do_reload_shared_cmd ====
-'''''amule_do_reload_shared_cmd()''''': Used to reload the list of shared files fom disk.
+===== Description =====
 ==== amule_do_download_cmd ====
-'''''amule_do_download_cmd($file_hash, $command, $optional_arg)''''': Used to change a parameter of a file in the downloads list. '''''$command''''' can be '''pause''', '''resume''', '''cancel''', '''prio''', '''prioup''' or '''priodown'''. In case of '''prio''', '''''$optional_arg''''' needs to contain the new priority.
+===== Description =====
 ==== amule_kad_connect ====
-'''''amule_kad_connect($bootstrap_ip, $bootstrap_port)''''': Used to connect to the [[Kad]] network.
+===== Description =====
 ==== amule_do_add_server_cmd ====
 '''''amule_do_add_server_cmd($server_addr, $server_port, $server_name)''''': Used to add a [[server]] to the [[server list]].
 ==== amule_do_server_cmd ====