2009-12-26 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

Documented system.multicall XML-RPC method in man page.
	* doc/aria2c.1.txt
pull/1/head
Tatsuhiro Tsujikawa 2009-12-26 14:36:38 +00:00
parent 63c6a16d40
commit 1b3436b5cd
4 changed files with 31 additions and 3 deletions

View File

@ -1,3 +1,8 @@
2009-12-26 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Documented system.multicall XML-RPC method in man page.
* doc/aria2c.1.txt
2009-12-26 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>
Added signal handler for SIGHUP to save .aria2 file when terminal

View File

@ -2,12 +2,12 @@
.\" Title: aria2c
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" 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\&.

View File

@ -3051,6 +3051,15 @@ enabledFeatures
</p>
</dd>
</dl></div>
<div class="paragraph"><p><strong>system.multicall</strong> <em>methods</em></p></div>
<div class="paragraph"><p>This methods encapsulates multiple method calls in a single request.
<em>methods</em> 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.</p></div>
<h3 id="_error_handling">Error Handling</h3><div style="clear:left"></div>
<div class="paragraph"><p>In case of error, aria2 returns faultCode=1 and the error message in
faultString.</p></div>
@ -3519,7 +3528,7 @@ files in the program, then also delete it here.</p></div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2009-12-25 23:48:03 JST
Last updated 2009-12-26 23:34:30 JST
</div>
</div>
</body>

View File

@ -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
~~~~~~~~~~~~~~