Module: sip-router Branch: master Commit: 5ca1a775f63f2b5f905fd89cafb0b614ee44b522 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5ca1a775...

Author: Andrei Pelinescu-Onciul andrei@iptel.org Committer: Andrei Pelinescu-Onciul andrei@iptel.org Date: Thu Jul 16 10:45:41 2009 +0200

ctl(s) doc: added the autoconversion parameter

- info about the new autoconversion parameter - README re-generated

---

modules_s/ctl/README | 24 +++++++++++++++++++++--- modules_s/ctl/doc/params.xml | 26 ++++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/modules_s/ctl/README b/modules_s/ctl/README index 7d538b0..12850b3 100644 --- a/modules_s/ctl/README +++ b/modules_s/ctl/README @@ -18,6 +18,7 @@ Andrei Pelinescu-Onciul 1.3.3. user (integer or string) 1.3.4. group (integer or string) 1.3.5. fifo (integer) + 1.3.6. autoconversion (integer)

1.4. RPC Functions

@@ -162,6 +163,23 @@ modparam("ctl", "fifo", "/tmp/ser_fifo2") modparam("ctl", "fifo", "udp:*:2050") # fifo protocol over udp modparam("ctl", "fifo", "tcp:*:2050") # fifo over tcp

+1.3.6. autoconversion (integer) + + Enable or disable automatic type conversion globally, for all the + methods parameters. If on, a type mismatch in a method parameter will + not cause a fault if it is possible to automatically convert it to the + expected type. + + Default: off + + It is recommended to leave this parameter to its default off value and + fix instead the client application (which should use the proper types) + or to modify the target rpc to accept any type (see the rpc scan '.' + modifier). + + Example 7. Set the autoconversion parameter +modparam("ctl", "autoconversion", 1) + 1.4. RPC Functions

Revision History @@ -171,7 +189,7 @@ modparam("ctl", "fifo", "tcp:*:2050") # fifo over tcp

List all the sockets on which the ctl module listens.

- Example 7. print usage + Example 8. print usage $ sercmd -f"[%v] %v:%v %v\n" ctl.listen [binrpc] unix_stream:/tmp/ser_ctl

@@ -181,7 +199,7 @@ modparam("ctl", "fifo", "tcp:*:2050") # fifo over tcp

Returns the number of open binrpc connections (to the ctl module).

- Example 8. ctl.connections usage + Example 9. ctl.connections usage $ sercmd ctl.connections 1

@@ -189,7 +207,7 @@ modparam("ctl", "fifo", "tcp:*:2050") # fifo over tcp

List open binrpc connections (to the ctl module).

- Example 9. ctl.who usage + Example 10. ctl.who usage $ sercmd -f"[%v] %v: %v %v -> %v %v\n" ctl.who [binrpc] unix_stream: <anonymous unix socket> -> /tmp/ser_ctl

diff --git a/modules_s/ctl/doc/params.xml b/modules_s/ctl/doc/params.xml index 2b9d807..c2b06c2 100644 --- a/modules_s/ctl/doc/params.xml +++ b/modules_s/ctl/doc/params.xml @@ -166,4 +166,30 @@ modparam("ctl", "fifo", "tcp:*:2050") # fifo over tcp </example> </section>

+ <section id="autoconversion"> + <title><varname>autoconversion</varname> (integer)</title> + <para> + Enable or disable automatic type conversion globally, for all the + methods parameters. + If on, a type mismatch in a method parameter will not cause a fault + if it is possible to automatically convert it to the expected type. + </para> + <para> + Default: off + </para> + <para> + It is recommended to leave this parameter to its default off value + and fix instead the client application (which should use the + proper types) or to modify the target rpc to accept any type + (see the rpc scan '.' modifier). + </para> + <example> + <title>Set the <varname>autoconversion</varname> parameter + </title> + <programlisting> +modparam("ctl", "autoconversion", 1) + </programlisting> + </example> + </section> + </section>