sr-dev

sr-dev@lists.kamailio.org

44307 discussions

git:master: doc: dump_selects.pl: fix bare <listitem> in generated xmls

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 0e146aac071284fd0d1ce0b4543e272a79d5c229 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0e146aa… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sun Mar 7 12:28:04 2010 +0100 doc: dump_selects.pl: fix bare <listitem> in generated xmls - <listitem></listitem> cannot contain bare text => switched to using <simpara></simpara> inside --- doc/scripts/cdefs2doc/dump_selects.pl | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/scripts/cdefs2doc/dump_selects.pl b/doc/scripts/cdefs2doc/dump_selects.pl index f88d252..aea0018 100755 --- a/doc/scripts/cdefs2doc/dump_selects.pl +++ b/doc/scripts/cdefs2doc/dump_selects.pl @@ -607,7 +607,7 @@ format DOCBOOK_FOOTER = . format DOCBOOK_SELLINE = - <listitem>@* + <listitem><simpara>@*</simpara> $name ~~<para>^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< </para> $desc

14 years, 11 months

git:master: doc: cfg_list regenerated

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: c1e5745fa5dc0d183d4c6d3eeb12befc264edb90 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c1e5745… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sun Mar 7 12:57:08 2010 +0100 doc: cfg_list regenerated --- doc/cfg_list/docbook/cfg_var_list.xml | 24 ++++++++++++++---------- 1 files changed, 14 insertions(+), 10 deletions(-) diff --git a/doc/cfg_list/docbook/cfg_var_list.xml b/doc/cfg_list/docbook/cfg_var_list.xml index 56862cf..7fa9958 100644 --- a/doc/cfg_list/docbook/cfg_var_list.xml +++ b/doc/cfg_list/docbook/cfg_var_list.xml @@ -1,22 +1,26 @@ <?xml version="1.0" encoding="UTF-8"?>  -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" + [ <!ENTITY % local.common.attrib + "xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'">] +> <book id="cfg_var_list" xmlns:xi="http://www.w3.org/2001/XInclude"> - <title>RPC Exports List</title> - <info><revhistory><revision> - <revnumber>sip-router git-d2924b</revnumber> + <title>Runtime Configuration Variables List</title> + <bookinfo><revhistory><revision> + <revnumber>sip-router git-f88145</revnumber> + <date>Sun, 07 Mar 2010 12:35:15 +0100</date> <revremark> Automatically generated by: make -C doc/cfg_list all </revremark> - </revision></revhistory></info> + </revision></revhistory></bookinfo> <xi:include href="cfg_core.xml"/> - <xi:include href="cfg_tcp.xml"/> <xi:include href="cfg_sctp.xml"/> - <xi:include href="cfg_maxfwd.xml"/> + <xi:include href="cfg_tcp.xml"/> <xi:include href="cfg_tm.xml"/> - <xi:include href="cfg_siputils.xml"/> - <xi:include href="cfg_registrar.xml"/> <xi:include href="cfg_ratelimit.xml"/> + <xi:include href="cfg_registrar.xml"/> + <xi:include href="cfg_siputils.xml"/> + <xi:include href="cfg_maxfwd.xml"/> </book>

14 years, 11 months

git:master: doc: rpc_lists regenerated

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: ebd482edb06d67883823a978925a7d8baae5b1db URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=ebd482e… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sun Mar 7 12:56:02 2010 +0100 doc: rpc_lists regenerated --- doc/rpc_list/docbook/rpc_list.xml | 48 ++++++++++++++++++++----------------- doc/rpc_list/docbook/rpc_tm.xml | 17 ++++++++---- doc/rpc_list/rpc_tm.txt | 17 ++++++++---- 3 files changed, 48 insertions(+), 34 deletions(-) diff --git a/doc/rpc_list/docbook/rpc_list.xml b/doc/rpc_list/docbook/rpc_list.xml index be598dc..6cc23b4 100644 --- a/doc/rpc_list/docbook/rpc_list.xml +++ b/doc/rpc_list/docbook/rpc_list.xml @@ -1,37 +1,41 @@ <?xml version="1.0" encoding="UTF-8"?>  -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" + [ <!ENTITY % local.common.attrib + "xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'">] +> <book id="rpc_list" xmlns:xi="http://www.w3.org/2001/XInclude"> <title>RPC Exports List</title> - <info><revhistory><revision> - <revnumber>sip-router git-4896b7</revnumber> + <bookinfo><revhistory><revision> + <revnumber>sip-router git-22a6f9</revnumber> + <date>Sun, 07 Mar 2010 12:53:13 +0100</date> <revremark> Automatically generated by: make -C doc/rpc_list all </revremark> - </revision></revhistory></info> + </revision></revhistory></bookinfo> <xi:include href="rpc_core.xml"/> - <xi:include href="rpc_pdt.xml"/> - <xi:include href="rpc_pike.xml"/> - <xi:include href="rpc_presence_b2b.xml"/> - <xi:include href="rpc_gflags.xml"/> - <xi:include href="rpc_dispatcher.xml"/> - <xi:include href="rpc_prefix_route.xml"/> - <xi:include href="rpc_domain.xml"/> - <xi:include href="rpc_cpl-c.xml"/> - <xi:include href="rpc_sl.xml"/> - <xi:include href="rpc_usrloc_s.xml"/> - <xi:include href="rpc_ratelimit.xml"/> - <xi:include href="rpc_tm.xml"/> - <xi:include href="rpc_tls.xml"/> - <xi:include href="rpc_lcr.xml"/> - <xi:include href="rpc_debugger.xml"/> - <xi:include href="rpc_ctl.xml"/> <xi:include href="rpc_cfg_rpc.xml"/> + <xi:include href="rpc_ctl.xml"/> <xi:include href="rpc_db_flatstore.xml"/> + <xi:include href="rpc_debugger.xml"/> + <xi:include href="rpc_lcr.xml"/> <xi:include href="rpc_mi_rpc.xml"/> + <xi:include href="rpc_tls.xml"/> + <xi:include href="rpc_tm.xml"/> <xi:include href="rpc_htable.xml"/> - <xi:include href="rpc_usrloc_k.xml"/> <xi:include href="rpc_uac.xml"/> + <xi:include href="rpc_usrloc_k.xml"/> + <xi:include href="rpc_cpl-c.xml"/> + <xi:include href="rpc_dispatcher.xml"/> + <xi:include href="rpc_domain.xml"/> + <xi:include href="rpc_gflags.xml"/> + <xi:include href="rpc_pdt.xml"/> + <xi:include href="rpc_pike.xml"/> + <xi:include href="rpc_prefix_route.xml"/> + <xi:include href="rpc_presence_b2b.xml"/> + <xi:include href="rpc_ratelimit.xml"/> + <xi:include href="rpc_sl.xml"/> + <xi:include href="rpc_usrloc_s.xml"/> </book> diff --git a/doc/rpc_list/docbook/rpc_tm.xml b/doc/rpc_list/docbook/rpc_tm.xml index 9147b1f..6b59300 100644 --- a/doc/rpc_list/docbook/rpc_tm.xml +++ b/doc/rpc_list/docbook/rpc_tm.xml @@ -10,7 +10,7 @@ RPC Exports for tm <section id="tm.cancel"><title>tm.cancel</title> <para> - Documentation missing (rpc_cancel_doc). + Cancel a pending transaction </para> <para> </para> @@ -18,7 +18,7 @@ RPC Exports for tm <section id="tm.reply"><title>tm.reply</title> <para> - Documentation missing (rpc_reply_doc). + Reply transaction </para> <para> </para> @@ -26,7 +26,7 @@ RPC Exports for tm <section id="tm.stats"><title>tm.stats</title> <para> - Documentation missing (tm_rpc_stats_doc). + Print transaction statistics. </para> <para> </para> @@ -34,7 +34,8 @@ RPC Exports for tm <section id="tm.hash_stats"><title>tm.hash_stats</title> <para> - Documentation missing (tm_rpc_hash_stats_doc). + Prints hash table statistics (can be used only if tm is + compiled with -DTM_HASH_STATS). </para> <para> </para> @@ -42,7 +43,9 @@ RPC Exports for tm <section id="tm.t_uac_start"><title>tm.t_uac_start</title> <para> - Documentation missing (rpc_t_uac_start_doc). + starts a tm uac using a list of string parameters: method, + ruri, dst_uri, send_sock, headers (CRLF separated) and body + (optional) </para> <para> </para> @@ -50,7 +53,9 @@ RPC Exports for tm <section id="tm.t_uac_wait"><title>tm.t_uac_wait</title> <para> - Documentation missing (rpc_t_uac_wait_doc). + starts a tm uac and waits for the final reply, using a list of + string parameters: method, ruri, dst_uri send_sock, headers + (CRLF separated) and body (optional) </para> <para> Returns an array. diff --git a/doc/rpc_list/rpc_tm.txt b/doc/rpc_list/rpc_tm.txt index 177ff05..60b0802 100644 --- a/doc/rpc_list/rpc_tm.txt +++ b/doc/rpc_list/rpc_tm.txt @@ -5,21 +5,26 @@ RPC Exports for tm 1. tm.cancel - Documentation missing (rpc_cancel_doc). + Cancel a pending transaction 2. tm.reply - Documentation missing (rpc_reply_doc). + Reply transaction 3. tm.stats - Documentation missing (tm_rpc_stats_doc). + Print transaction statistics. 4. tm.hash_stats - Documentation missing (tm_rpc_hash_stats_doc). + Prints hash table statistics (can be used only if tm is + compiled with -DTM_HASH_STATS). 5. tm.t_uac_start - Documentation missing (rpc_t_uac_start_doc). + starts a tm uac using a list of string parameters: method, + ruri, dst_uri, send_sock, headers (CRLF separated) and body + (optional) 6. tm.t_uac_wait - Documentation missing (rpc_t_uac_wait_doc). + starts a tm uac and waits for the final reply, using a list of + string parameters: method, ruri, dst_uri send_sock, headers + (CRLF separated) and body (optional) Returns an array.

14 years, 11 months

git:master: doc: *_list: fix xmllint errors and TOC

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: e6b92a08389e09bbddb7c30d1a328db00c6a8f2d URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=e6b92a0… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sun Mar 7 12:24:02 2010 +0100 doc: *_list: fix xmllint errors and TOC - fix xmllint erros - use a 0-level TOC (such that the main TOC will list only the chapters and not also the sections) --- doc/cfg_list/Makefile | 12 ++++++++---- doc/cfg_list/docbook/Makefile | 2 ++ doc/rpc_list/Makefile | 12 ++++++++---- doc/rpc_list/docbook/Makefile | 2 ++ doc/select_list/Makefile | 12 ++++++++---- doc/select_list/docbook/Makefile | 2 ++ doc/select_list/docbook/intro.xml | 30 +++++++++++++++--------------- 7 files changed, 45 insertions(+), 27 deletions(-) diff --git a/doc/cfg_list/Makefile b/doc/cfg_list/Makefile index c72f621..16d645a 100644 --- a/doc/cfg_list/Makefile +++ b/doc/cfg_list/Makefile @@ -197,18 +197,22 @@ $(docbook_output_dir)/cfg_var_list.xml: Makefile \ $(foreach f,$(flist),$(docbook_output_dir)/$(call get_target,$f).xml) @echo '<?xml version="1.0" encoding="UTF-8"?>' >$@ @echo '' >>$@ - @echo '<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ - @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">' >>$@ + @echo '<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ + @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"' >>$@ + @echo ' [ <!ENTITY % local.common.attrib' >>$@ + @echo " \"xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'\">]">>$@ + @echo '>' >>$@ @echo '<book id="cfg_var_list"'\ 'xmlns:xi="http://www.w3.org/2001/XInclude">' >>$@ @echo ' <title>Runtime Configuration Variables List</title>' >>$@ - @echo ' <info><revhistory><revision>' >>$@ + @echo ' <bookinfo><revhistory><revision>' >>$@ @echo ' <revnumber>'$(repo_ver)'</revnumber>' >>$@ + @echo ' <date>'`date -R`'</date>' >>$@ @echo ' <revremark>' >>$@ @echo " Automatically generated by:">>$@ @echo " $(MAKE) -C doc/cfg_list $(MAKECMDGOALS)" >>$@ @echo ' </revremark>' >>$@ - @echo ' </revision></revhistory></info>' >>$@ + @echo ' </revision></revhistory></bookinfo>' >>$@ @$(foreach f,$(flist),\ echo ' <xi:include'\ 'href="'$(call get_target,$f).xml'"/>' \ diff --git a/doc/cfg_list/docbook/Makefile b/doc/cfg_list/docbook/Makefile index d0f65d2..8a30bf3 100644 --- a/doc/cfg_list/docbook/Makefile +++ b/doc/cfg_list/docbook/Makefile @@ -1,5 +1,7 @@ docs = cfg_var_list.xml docbook_dir = ../../../docbook +# no subsection listed in the main TOC +xsltproc_flags+=--stringparam toc.section.depth 0 include $(docbook_dir)/Makefile diff --git a/doc/rpc_list/Makefile b/doc/rpc_list/Makefile index dbcea55..80a9783 100644 --- a/doc/rpc_list/Makefile +++ b/doc/rpc_list/Makefile @@ -213,18 +213,22 @@ $(docbook_output_dir)/rpc_list.xml: Makefile \ $(foreach f,$(flist),$(docbook_output_dir)/$(call get_target,$f).xml) @echo '<?xml version="1.0" encoding="UTF-8"?>' >$@ @echo '' >>$@ - @echo '<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ - @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">' >>$@ + @echo '<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ + @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"' >>$@ + @echo ' [ <!ENTITY % local.common.attrib' >>$@ + @echo " \"xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'\">]">>$@ + @echo '>' >>$@ @echo '<book id="rpc_list"'\ 'xmlns:xi="http://www.w3.org/2001/XInclude">' >>$@ @echo ' <title>RPC Exports List</title>' >>$@ - @echo ' <info><revhistory><revision>' >>$@ + @echo ' <bookinfo><revhistory><revision>' >>$@ @echo ' <revnumber>'$(repo_ver)'</revnumber>' >>$@ + @echo ' <date>'`date -R`'</date>' >>$@ @echo ' <revremark>' >>$@ @echo " Automatically generated by:">>$@ @echo " $(MAKE) -C doc/rpc_list $(MAKECMDGOALS)" >>$@ @echo ' </revremark>' >>$@ - @echo ' </revision></revhistory></info>' >>$@ + @echo ' </revision></revhistory></bookinfo>' >>$@ @$(foreach f,$(flist),\ echo ' <xi:include'\ 'href="'$(call get_target,$f).xml'"/>' \ diff --git a/doc/rpc_list/docbook/Makefile b/doc/rpc_list/docbook/Makefile index c76cc9f..e31800d 100644 --- a/doc/rpc_list/docbook/Makefile +++ b/doc/rpc_list/docbook/Makefile @@ -1,5 +1,7 @@ docs = rpc_list.xml docbook_dir = ../../../docbook +# no subsection listed in the main TOC +xsltproc_flags+=--stringparam toc.section.depth 0 include $(docbook_dir)/Makefile diff --git a/doc/select_list/Makefile b/doc/select_list/Makefile index b50c852..e3f510e 100644 --- a/doc/select_list/Makefile +++ b/doc/select_list/Makefile @@ -212,18 +212,22 @@ $(docbook_output_dir)/select_list.xml: Makefile \ $(foreach f,$(flist),$(docbook_output_dir)/$(call get_target,$f).xml) @echo '<?xml version="1.0" encoding="UTF-8"?>' >$@ @echo '' >>$@ - @echo '<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ - @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">' >>$@ + @echo '<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"' >>$@ + @echo ' "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"' >>$@ + @echo ' [ <!ENTITY % local.common.attrib' >>$@ + @echo " \"xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'\">]">>$@ + @echo '>' >>$@ @echo '<book id="select_list"'\ 'xmlns:xi="http://www.w3.org/2001/XInclude">' >>$@ @echo ' <title>Select List</title>' >>$@ - @echo ' <info><revhistory><revision>' >>$@ + @echo ' <bookinfo><revhistory><revision>' >>$@ @echo ' <revnumber>'$(repo_ver)'</revnumber>' >>$@ + @echo ' <date>'`date -R`'</date>' >>$@ @echo ' <revremark>' >>$@ @echo " Automatically generated by:">>$@ @echo " $(MAKE) -C doc/select_list $(MAKECMDGOALS)" >>$@ @echo ' </revremark>' >>$@ - @echo ' </revision></revhistory></info>' >>$@ + @echo ' </revision></revhistory></bookinfo>' >>$@ @echo ' <xi:include href="intro.xml"/>' >>$@ @$(foreach f,$(flist),\ echo ' <xi:include'\ diff --git a/doc/select_list/docbook/Makefile b/doc/select_list/docbook/Makefile index 95cc961..827b10c 100644 --- a/doc/select_list/docbook/Makefile +++ b/doc/select_list/docbook/Makefile @@ -1,5 +1,7 @@ docs = select_list.xml docbook_dir = ../../../docbook +# no subsection listed in the main TOC +xsltproc_flags+=--stringparam toc.section.depth 0 include $(docbook_dir)/Makefile diff --git a/doc/select_list/docbook/intro.xml b/doc/select_list/docbook/intro.xml index da9e852..7ca52ce 100644 --- a/doc/select_list/docbook/intro.xml +++ b/doc/select_list/docbook/intro.xml @@ -21,21 +21,21 @@ <title>Notations</title> <para>The following notations are used: <orderedlist> - <listitem>@ - all selects always start with '@'. </listitem> - <listitem>"string" - string type.</listitem> - <listitem>integer - integer type.</listitem> - <listitem>[] - Parameter markers. Can be either [integer] or + <listitem><para>@ - all selects always start with '@'.</para></listitem> + <listitem><para>"string" - string type.</para></listitem> + <listitem><para>integer - integer type.</para></listitem> + <listitem><para>[] - Parameter markers. Can be either [integer] or ["string"]. Note that instead of ["string"] one could write .string, e.g.: @foo.bar["string"] is equivalent to @foo.bar.string. - </listitem> - <listitem>{} - denotes an optional parameter. + </para></listitem> + <listitem><para>{} - denotes an optional parameter. E.g.: @ruri.params{["string"]} means you could use @ruri.params by itself or you could specify an extra parameter: @ruri.params["trasnport"] or @ruri.params.transport. - </listitem> - <listitem><string> - means the next member is not fixed and can + </para></listitem> + <listitem><para><string> - means the next member is not fixed and can take any string value (it is a string parameter). It is equivalent with ["string"], e.g.: @msg.header.<string> is the same as @@ -43,18 +43,18 @@ It is used only to expose an internal implementation detail (SEL_PARAM_* vs. CONSUME_NEXT_*), but from the script writer point of view it is the same thing. - </listitem> - <listitem>.* - means the select can be followed by a variable number of - string parameters. + </para></listitem> + <listitem><para>.* - means the select can be followed by a variable number + of string parameters. E.g.: @cfg_get.* means that @cfg_get.core.version is a valid usage. - </listitem> - <listitem>* (without a '.' in front) - it means the last member - might be a class that might expand further (but the + </para></listitem> + <listitem><para>* (without a '.' in front) - it means the + last member might be a class that might expand further (but the "expansion" is not defined in the same module). E.g. @foo.nameaddr* means that nameaddr is most likely a class that expands further (for example into @foo.nameaddr.uri a.s.o). - </listitem> + </para></listitem> </orderedlist> </para> </section>

14 years, 11 months

git:master: doc rpc: fix xmllint errors

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: f881456904969e1b2074cfd94af0daed9eef1292 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=f881456… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sun Mar 7 12:31:59 2010 +0100 doc rpc: fix xmllint errors Fix unsupported xmlns:xi attrib., missing example titles and text or examples outside sections. --- doc/rpc/ser_rpc.xml | 32 ++++++++++++++++++++++---------- 1 files changed, 22 insertions(+), 10 deletions(-) diff --git a/doc/rpc/ser_rpc.xml b/doc/rpc/ser_rpc.xml index 9ce6fef..295413b 100644 --- a/doc/rpc/ser_rpc.xml +++ b/doc/rpc/ser_rpc.xml @@ -1,6 +1,9 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" + [ <!ENTITY % local.common.attrib + "xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'">] +> <section id="ser_rpc" xmlns:xi="http://www.w3.org/2001/XInclude"> <!-- @@ -155,9 +158,11 @@ typedef struct rpc_export { (defined in rpc_lookup.h), from the module init function (mod_init()). This is the <emphasis>recommended</emphasis> method for all the new modules. - <example> + <example><title>usrloc RPC Exports Declaration</title> + <para> The <varname>rpc_export_t</varname> array for the usrloc module looks like: + </para> <programlisting> <emphasis> rpc_export_t ul_rpc[] = { @@ -172,8 +177,10 @@ rpc_export_t ul_rpc[] = { }; </emphasis> </programlisting> + <para> To register it from the module init function one would use something similar to: + </para> <programlisting> if (rpc_register_array(ul_rpc) != 0) { ERR("failed to register RPC commands\n"); @@ -214,7 +221,7 @@ struct module_exports { functions of the usrloc module, using the rpc_export_t array <emphasis>ul_rpc</emphasis> defined above, in the rpc_register_array() example: - <example> + <example><title>usrloc Module Exports Declaration</title> <programlisting> struct module_exports exports = { "usrloc", @@ -229,13 +236,13 @@ struct module_exports exports = { </programlisting> </example> - <note> + <note><para> This mode works only with modules using the SER module interface. It does not work for kamailio modules and it will probably not work for future sip-router modules. It is safer and recommended to use instead the <function>rpc_register_array()</function> function. - </note> + </para></note> </para></listitem> </itemizedlist> </para> @@ -470,10 +477,11 @@ rpc->scan("f", &double_val); Function <function>struct_scan</function> can be used to retrieve named attributes from a parameter of type structure. - <note>This function is obsolete and not implemented by all the + <note><para> + This function is obsolete and not implemented by all the rpc transports (e.g.: ctl / binrpc). Consider using the normal <function>scan</function> instead. - </note> + </para></note> When retrieving a structure parameter from the parameter set: <programlisting> @@ -501,8 +509,9 @@ rpc->struct_scan(handle, "sd", "str_attr", &str_val, "int_attr", &int_va the structure. </para> </section> - - <example> + + <section><title>Retrieving Parameters Example</title> + <example> <title>Retrieving Parameters</title> <programlisting> <![CDATA[ @@ -555,6 +564,7 @@ static void core_echo(rpc_t* rpc, void* c) ]]> </programlisting> </example> + </section> </section> <section id="rpc.creating_result"> @@ -849,7 +859,9 @@ static void rpc_register(rpc_t* rpc) <section id="rpc.new_transport"> <title>Implementing New Transports</title> + <remark> To be done. + </remark> <!-- TODO: - create a new module - take a look at sip_router/rpc.h

14 years, 11 months

git:master: tm: rpc doc strings moved to tm.c

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 22a6f9805b0ee13357110edf201d301039119870 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=22a6f98… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sun Mar 7 12:52:27 2010 +0100 tm: rpc doc strings moved to tm.c Moved all the rpc doc strings into tm.c, close to the rpc exports declaration. This will also allow automatic documentation generation for the rpcs (the script that generates the rpc docs, parses C code and cannot "resolve" symbols defined in other files). --- modules/tm/rpc_uac.c | 15 ------------ modules/tm/rpc_uac.h | 2 - modules/tm/t_cancel.c | 6 ----- modules/tm/t_cancel.h | 1 - modules/tm/t_reply.c | 5 ---- modules/tm/t_reply.h | 1 - modules/tm/t_stats.c | 11 --------- modules/tm/t_stats.h | 2 - modules/tm/tm.c | 60 +++++++++++++++++++++++++++++++++++++++++------- 9 files changed, 51 insertions(+), 52 deletions(-) diff --git a/modules/tm/rpc_uac.c b/modules/tm/rpc_uac.c index f177094..34f7c36 100644 --- a/modules/tm/rpc_uac.c +++ b/modules/tm/rpc_uac.c @@ -57,21 +57,6 @@ struct str_list { -const char* rpc_t_uac_start_doc[2] = { - "starts a tm uac using a list of string parameters: method, ruri, dst_uri" - ", send_sock, headers (CRLF separated) and body (optional)", - 0 -}; - -const char* rpc_t_uac_wait_doc[2] = { - "starts a tm uac and waits for the final reply, using a list of string " - "parameters: method, ruri, dst_uri send_sock, headers (CRLF separated)" - " and body (optional)", - 0 -}; - - - /** make sure the rpc user created the msg properly. * Make sure that the FIFO user created the message * correctly and fill some extra parameters in function diff --git a/modules/tm/rpc_uac.h b/modules/tm/rpc_uac.h index df8d9e8..0aa5c00 100644 --- a/modules/tm/rpc_uac.h +++ b/modules/tm/rpc_uac.h @@ -29,8 +29,6 @@ #include "../../rpc.h" -extern const char* rpc_t_uac_start_doc[2]; -extern const char* rpc_t_uac_wait_doc[2]; void rpc_t_uac_start(rpc_t* rpc, void* c); void rpc_t_uac_wait(rpc_t* rpc, void* c); diff --git a/modules/tm/t_cancel.c b/modules/tm/t_cancel.c index 52f086b..bae4d32 100644 --- a/modules/tm/t_cancel.c +++ b/modules/tm/t_cancel.c @@ -322,12 +322,6 @@ int cancel_branch( struct cell *t, int branch, int flags ) } -const char* rpc_cancel_doc[2] = { - "Cancel a pending transaction", - 0 -}; - - /* fifo command to cancel a pending call (Uli) * Syntax: * diff --git a/modules/tm/t_cancel.h b/modules/tm/t_cancel.h index 0ef3f37..9e22dc8 100644 --- a/modules/tm/t_cancel.h +++ b/modules/tm/t_cancel.h @@ -128,7 +128,6 @@ inline short static prepare_cancel_branch( struct cell *t, int b, int noreply ) return 0; } -extern const char* rpc_cancel_doc[2]; void rpc_cancel(rpc_t* rpc, void* c); int cancel_b_flags_fixup(void* handle, str* gname, str* name, void** val); int cancel_b_flags_get(unsigned int* f, int m); diff --git a/modules/tm/t_reply.c b/modules/tm/t_reply.c index f28cf05..4415294 100644 --- a/modules/tm/t_reply.c +++ b/modules/tm/t_reply.c @@ -2431,11 +2431,6 @@ static int send_reply(struct cell *trans, unsigned int code, str* text, str* bod #endif -const char* rpc_reply_doc[2] = { - "Reply transaction", - 0 -}; - /* Syntax: diff --git a/modules/tm/t_reply.h b/modules/tm/t_reply.h index 0a97e6a..7ea9dc8 100644 --- a/modules/tm/t_reply.h +++ b/modules/tm/t_reply.h @@ -155,7 +155,6 @@ int t_pick_branch_blind(struct cell *t, int *res_code); */ void t_drop_replies(int v); -extern const char* rpc_reply_doc[2]; void rpc_reply(rpc_t* rpc, void* c); void faked_env( struct cell *t,struct sip_msg *msg); diff --git a/modules/tm/t_stats.c b/modules/tm/t_stats.c index 627b379..69573a5 100644 --- a/modules/tm/t_stats.c +++ b/modules/tm/t_stats.c @@ -94,17 +94,6 @@ void free_tm_stats() -const char* tm_rpc_stats_doc[2] = { - "Print transaction statistics.", - 0 -}; - -const char* tm_rpc_hash_stats_doc[2] = { - "Prints hash table statistics (can be used only if tm is compiled" - " with -DTM_HASH_STATS).", - 0 -}; - /* res=s1+s2 */ #define tm_proc_stats_add_base(res, s1, s2) \ do{\ diff --git a/modules/tm/t_stats.h b/modules/tm/t_stats.h index 734b4ad..33fb9fa 100644 --- a/modules/tm/t_stats.h +++ b/modules/tm/t_stats.h @@ -141,10 +141,8 @@ int init_tm_stats(void); int init_tm_stats_child(void); void free_tm_stats(); -extern const char* tm_rpc_stats_doc[2]; void tm_rpc_stats(rpc_t* rpc, void* c); -extern const char* tm_rpc_hash_stats_doc[2]; void tm_rpc_hash_stats(rpc_t* rpc, void* c); typedef int (*tm_get_stats_f)(struct t_proc_stats *all); diff --git a/modules/tm/tm.c b/modules/tm/tm.c index 2b35681..34a9e9f 100644 --- a/modules/tm/tm.c +++ b/modules/tm/tm.c @@ -1906,15 +1906,7 @@ static int w_t_save_lumps(struct sip_msg* msg, char* foo, char* bar) #endif } -static rpc_export_t tm_rpc[] = { - {"tm.cancel", rpc_cancel, rpc_cancel_doc, 0}, - {"tm.reply", rpc_reply, rpc_reply_doc, 0}, - {"tm.stats", tm_rpc_stats, tm_rpc_stats_doc, 0}, - {"tm.hash_stats", tm_rpc_hash_stats, tm_rpc_hash_stats_doc, 0}, - {"tm.t_uac_start", rpc_t_uac_start, rpc_t_uac_start_doc, 0 }, - {"tm.t_uac_wait", rpc_t_uac_wait, rpc_t_uac_wait_doc, RET_ARRAY}, - {0, 0, 0, 0} -}; + /* wrapper function needed after changes in w_t_reply */ int w_t_reply_wrp(struct sip_msg *m, unsigned int code, char *txt) @@ -2143,3 +2135,53 @@ inline static int w_t_relay_to(struct sip_msg *msg, char *proxy, char *flags) return _w_t_relay_to(msg, px, PROTO_NONE); } + + +/* rpc docs */ + +static const char* rpc_cancel_doc[2] = { + "Cancel a pending transaction", + 0 +}; + +static const char* rpc_reply_doc[2] = { + "Reply transaction", + 0 +}; + +static const char* tm_rpc_stats_doc[2] = { + "Print transaction statistics.", + 0 +}; + +static const char* tm_rpc_hash_stats_doc[2] = { + "Prints hash table statistics (can be used only if tm is compiled" + " with -DTM_HASH_STATS).", + 0 +}; + +static const char* rpc_t_uac_start_doc[2] = { + "starts a tm uac using a list of string parameters: method, ruri, dst_uri" + ", send_sock, headers (CRLF separated) and body (optional)", + 0 +}; + +static const char* rpc_t_uac_wait_doc[2] = { + "starts a tm uac and waits for the final reply, using a list of string " + "parameters: method, ruri, dst_uri send_sock, headers (CRLF separated)" + " and body (optional)", + 0 +}; + + +/* rpc exports */ +static rpc_export_t tm_rpc[] = { + {"tm.cancel", rpc_cancel, rpc_cancel_doc, 0}, + {"tm.reply", rpc_reply, rpc_reply_doc, 0}, + {"tm.stats", tm_rpc_stats, tm_rpc_stats_doc, 0}, + {"tm.hash_stats", tm_rpc_hash_stats, tm_rpc_hash_stats_doc, 0}, + {"tm.t_uac_start", rpc_t_uac_start, rpc_t_uac_start_doc, 0 }, + {"tm.t_uac_wait", rpc_t_uac_wait, rpc_t_uac_wait_doc, RET_ARRAY}, + {0, 0, 0, 0} +}; +

14 years, 11 months

git:master: doc: select_list regenerated

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 0e68e1dbc046a2039cb35b494265ae9efc708fc1 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0e68e1d… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sun Mar 7 12:58:06 2010 +0100 doc: select_list regenerated --- doc/select_list/docbook/select_avp.xml | 12 +- doc/select_list/docbook/select_core.xml | 978 +++++++++++++------------- doc/select_list/docbook/select_db_ops.xml | 232 +++--- doc/select_list/docbook/select_eval.xml | 96 ++-- doc/select_list/docbook/select_list.xml | 28 +- doc/select_list/docbook/select_nathelper.xml | 26 +- doc/select_list/docbook/select_rr.xml | 2 +- doc/select_list/docbook/select_textops.xml | 64 +- doc/select_list/docbook/select_timer.xml | 4 +- doc/select_list/docbook/select_tls.xml | 816 +++++++++++----------- doc/select_list/docbook/select_tm.xml | 40 +- doc/select_list/docbook/select_xmlrpc.xml | 2 +- 12 files changed, 1152 insertions(+), 1148 deletions(-) Diff: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commitdiff;h=0e6…

14 years, 11 months

git:master: doc: *_list makefiles and files lists updates

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: 14cf120a5ab36260f0ed8b165386c638581886aa URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=14cf120… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Sat Mar 6 13:57:46 2010 +0100 doc: *_list makefiles and files lists updates - added new makefile targets: gen-files-list (generate the file lists in a makefile-ready-to-paste format), diff-list (searches for files and prints the one which are not listed in the makefile). - updated make autogen to obey the excluded file and group lists - updated the files lists for cfg_list, rpc_list and select_list. Now they are in alphabetical order, with core groups first, as generated by make gen-files-list. - fixed title for the config var list --- doc/cfg_list/Makefile | 101 ++++++++++++++++++++++++++------------ doc/rpc_list/Makefile | 122 +++++++++++++++++++++++++++++---------------- doc/select_list/Makefile | 109 +++++++++++++++++++++++++++-------------- 3 files changed, 219 insertions(+), 113 deletions(-) Diff: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commitdiff;h=14c…

14 years, 11 months

[tracker] Task opened: Kamailio 1.5 Dispatcher (minor) problem.

by sip-router

THIS IS AN AUTOMATED MESSAGE, DO NOT REPLY. A new Flyspray task has been opened. Details are below. User who did this - Geoff Mina (geoff2010) Attached to Project - sip-router Summary - Kamailio 1.5 Dispatcher (minor) problem. Task Type - Bug Report Category - Module Status - Unconfirmed Assigned To - Operating System - Linux Severity - Low Priority - Normal Reported Version - Development Due in Version - Undecided Due Date - Undecided Details - I am experiencing an issue with Kamailio 1.5 and the Dispatcher module. I have 2 network cards eth0 - public network interface. I actually have eth0 and eth0:1 with two public IPs bound to the interface eth1 - private network interface. The issue is that when I do not explicitly specify the "listen" configuration parameter, all my dispatch destinations NOT on the same public subnet get stuck in "P" state and never have calls routed to them. I have two datacenters which house racks of asterisk servers. My carriers send all SIP traffic to my primary SIP gateway, which then distributes the INVITE requests across the public internet to distribute the load between my two facilities. If I leave out the listen statements below, the asterisk servers outside of my 208.X.X.X network won't receive calls. When I include those lines, everything works fine. ###### Global Parameters ##### debug=1 log_stderror=no log_facility=LOG_LOCAL0 fork=yes children=16 disable_tcp=yes ##### ## These are the lines in question. ## Remove and things break, include and we are OK ##### listen=208.X.X.X:5060 listen=208.X.X.Y:5060 listen=10.3.200.201:5060 ## Enable Dispatcher module ## loadmodule "dispatcher.so" modparam("dispatcher","flags",2) modparam("dispatcher","db_url","mysql://appservers:appservers@localhost/kamailio") modparam("dispatcher","table_name","dispatcher") modparam("dispatcher","dst_avp","$avp(i:271)") modparam("dispatcher","grp_avp","$avp(i:272)") modparam("dispatcher","cnt_avp","$avp(i:273)") modparam("dispatcher","ds_ping_method","OPTIONS") modparam("dispatcher","ds_ping_from","sip:monitoring@mydomain.com") modparam("dispatcher","ds_ping_interval",30) modparam("dispatcher","ds_probing_mode",1) modparam("dispatcher","ds_probing_threshhold", 2) More information can be found at the following URL: http://sip-router.org/tracker/index.php?do=details&task_id=40 You are receiving this message because you have requested it from the Flyspray bugtracking system. If you did not expect this message or don't want to receive mails in future, you can change your notification settings at the URL shown above.

14 years, 11 months

git:master: doc: cfg_list regenerated

by Andrei Pelinescu-Onciul

Module: sip-router Branch: master Commit: c34a6c8ab47caa8d19ff869e6f55c15a1aab397d URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c34a6c8… Author: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Committer: Andrei Pelinescu-Onciul <andrei(a)iptel.org> Date: Fri Mar 5 19:17:06 2010 +0100 doc: cfg_list regenerated --- doc/cfg_list/cfg_core.txt | 78 ++++++++++++++-------- doc/cfg_list/cfg_ratelimit.txt | 17 +++++ doc/cfg_list/cfg_registrar.txt | 58 ++++++++++++++++ doc/cfg_list/cfg_sctp.txt | 3 +- doc/cfg_list/cfg_siputils.txt | 11 +++ doc/cfg_list/cfg_tm.txt | 74 ++++++++++++--------- doc/cfg_list/docbook/cfg_core.xml | 44 ++++++++++++ doc/cfg_list/docbook/cfg_ratelimit.xml | 32 +++++++++ doc/cfg_list/docbook/cfg_registrar.xml | 115 ++++++++++++++++++++++++++++++++ doc/cfg_list/docbook/cfg_sctp.xml | 3 +- doc/cfg_list/docbook/cfg_siputils.xml | 20 ++++++ doc/cfg_list/docbook/cfg_tm.xml | 34 +++++++--- doc/cfg_list/docbook/cfg_var_list.xml | 5 +- 13 files changed, 421 insertions(+), 73 deletions(-) Diff: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commitdiff;h=c34…

14 years, 11 months

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

sr-dev