From 1b3436b5cdc2bd7e397a18093fdadefa53a1d926 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sat, 26 Dec 2009 14:36:38 +0000 Subject: [PATCH] 2009-12-26 Tatsuhiro Tsujikawa Documented system.multicall XML-RPC method in man page. * doc/aria2c.1.txt --- ChangeLog | 5 +++++ doc/aria2c.1 | 8 ++++++-- doc/aria2c.1.html | 11 ++++++++++- doc/aria2c.1.txt | 10 ++++++++++ 4 files changed, 31 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index 7dacb180..7fe18a80 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-12-26 Tatsuhiro Tsujikawa + + Documented system.multicall XML-RPC method in man page. + * doc/aria2c.1.txt + 2009-12-26 Tatsuhiro Tsujikawa Added signal handler for SIGHUP to save .aria2 file when terminal diff --git a/doc/aria2c.1 b/doc/aria2c.1 index de9767de..4ac08d8f 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -2,12 +2,12 @@ .\" Title: aria2c .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 12/25/2009 +.\" Date: 12/26/2009 .\" Manual: Aria2 Manual .\" Source: Aria2 .\" Language: English .\" -.TH "ARIA2C" "1" "12/25/2009" "Aria2" "Aria2 Manual" +.TH "ARIA2C" "1" "12/26/2009" "Aria2" "Aria2 Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -2358,6 +2358,10 @@ enabledFeatures .RS 4 List of enabled features\&. Each feature name is of type string\&. .RE +.sp +\fBsystem\&.multicall\fR \fImethods\fR +.sp +This methods encapsulates multiple method calls in a single request\&. \fImethods\fR is of type array and its element is struct\&. The struct contains two keys: "methodName" and "params"\&. "methodName" is the method name to call and "params" is array containing parameters to the method\&. This method returns array of responses\&. The element of array will either be a one\-item array containing the return value of each method call or struct of fault element if an encapsulated method call fails\&. .SS "Error Handling" .sp In case of error, aria2 returns faultCode=1 and the error message in faultString\&. diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 3f44966f..b9a0d62a 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -3051,6 +3051,15 @@ enabledFeatures

+

system.multicall methods

+

This methods encapsulates multiple method calls in a single request. +methods is of type array and its element is struct. The struct +contains two keys: "methodName" and "params". "methodName" is the +method name to call and "params" is array containing parameters to the +method. This method returns array of responses. The element of array +will either be a one-item array containing the return value of each +method call or struct of fault element if an encapsulated method call +fails.

Error Handling

In case of error, aria2 returns faultCode=1 and the error message in faultString.

@@ -3519,7 +3528,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index 603e962a..3b133fb7 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -1405,6 +1405,16 @@ enabledFeatures:: List of enabled features. Each feature name is of type string. +*system.multicall* 'methods' + +This methods encapsulates multiple method calls in a single request. +'methods' is of type array and its element is struct. The struct +contains two keys: "methodName" and "params". "methodName" is the +method name to call and "params" is array containing parameters to the +method. This method returns array of responses. The element of array +will either be a one-item array containing the return value of each +method call or struct of fault element if an encapsulated method call +fails. Error Handling ~~~~~~~~~~~~~~