sr-dev March 2010

sr-dev@lists.kamailio.org

24 participants
359 discussions

git:kamailio_3.0: modules_k/ permisssions Fixed a bug that caused a segmentation fault if the mi_fifo subnet_dump was issued

by Henning Westerholt

Module: sip-router Branch: kamailio_3.0 Commit: 2fc570bbca38c634242c8fc40cfbcc06987c5b4a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=2fc570b… Author: Marius Zbihlei <marius.zbihlei(a)1and1.ro> Committer: Henning Westerholt <henning.westerholt(a)1und1.de> Date: Fri Mar 5 16:54:58 2010 +0200 modules_k/permisssions Fixed a bug that caused a segmentation fault if the mi_fifo subnet_dump was issued but the permissions module was not fully configured (no db url given) (cherry picked from commit d5da961b7ac62037fb1fb24c6ce3484584f5f972) --- modules_k/permissions/mi.c | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/modules_k/permissions/mi.c b/modules_k/permissions/mi.c index 9b4594a..c2f900f 100644 --- a/modules_k/permissions/mi.c +++ b/modules_k/permissions/mi.c @@ -116,7 +116,7 @@ struct mi_root* mi_subnet_dump(struct mi_root *cmd_tree, void *param) rpl_tree = init_mi_tree( 200, MI_SSTR(MI_OK)); if (rpl_tree==NULL) return 0; - if(subnet_table_mi_print(*subnet_table, &rpl_tree->node) < 0) { + if(subnet_table && subnet_table_mi_print(*subnet_table, &rpl_tree->node) < 0) { LM_ERR("failed to add a node\n"); free_mi_tree(rpl_tree); return 0;

14 years, 9 months

git:kamailio_3.0: sl(k): docs extension, merge README

by Henning Westerholt

Module: sip-router Branch: kamailio_3.0 Commit: 45af92ac46a1948b65133d78baaac046e2f7eb78 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=45af92a… Author: Henning Westerholt <henning.westerholt(a)1und1.de> Committer: Henning Westerholt <henning.westerholt(a)1und1.de> Date: Mon Mar 8 15:31:15 2010 +0100 sl(k): docs extension, merge README --- modules_k/sl/README | 13 +++++++++++++ modules_k/sl/doc/sl_admin.xml | 3 ++- 2 files changed, 15 insertions(+), 1 deletions(-) diff --git a/modules_k/sl/README b/modules_k/sl/README index 1f727e2..bf4b730 100644 --- a/modules_k/sl/README +++ b/modules_k/sl/README @@ -27,6 +27,7 @@ Bogdan Iancu 1.3. Exported Parameters 1.3.1. enable_stats (integer) + 1.3.2 bind_tm (integer) 1.4. Exported Functions @@ -113,6 +114,18 @@ Chapter 1. Admin Guide Example 1.1. enable_stats example modparam("sl", "enable_stats", 0) +1.3.1. bind_tm (integer) + + If the module should use transaction support for sending the + replies. A zero value means disabled. + + Module tm should be loaded before of this one + + Default value is 1 (enabled). + + Example 1.1. bind_tm example +modparam("sl", "bind_tm", 0) + 1.4. Exported Functions 1.4.1. sl_send_reply(code, reason) diff --git a/modules_k/sl/doc/sl_admin.xml b/modules_k/sl/doc/sl_admin.xml index d6a4702..59bcb74 100644 --- a/modules_k/sl/doc/sl_admin.xml +++ b/modules_k/sl/doc/sl_admin.xml @@ -55,7 +55,8 @@ <itemizedlist> <listitem> <para> - <emphasis>No dependencies on other &kamailio; modules</emphasis>. + <emphasis>TM - transaction module</emphasis>, if you want + to use the transactional send_reply functionality. </para> </listitem> </itemizedlist>

14 years, 9 months

git:kamailio_3.0: reg(k): fix a (probably) copy and paste error

by Henning Westerholt

Module: sip-router Branch: kamailio_3.0 Commit: 7b18e462c759d0d1f69d37fb01a2ce482afbf9da URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=7b18e46… Author: Henning Westerholt <henning.westerholt(a)1und1.de> Committer: Henning Westerholt <henning.westerholt(a)1und1.de> Date: Tue Jan 26 17:50:02 2010 +0100 reg(k): fix a (probably) copy and paste error (cherry picked from commit bf89ebf74025597c261b5b664e29fe0ab6bcfc25) --- modules_k/registrar/README | 4 ++-- modules_k/registrar/doc/registrar_admin.xml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules_k/registrar/README b/modules_k/registrar/README index 5344ffc..cbbaf89 100644 --- a/modules_k/registrar/README +++ b/modules_k/registrar/README @@ -110,7 +110,7 @@ Bogdan-Andre Iancu 1.25. registered usage 1.26. registered usage 1.27. registered usage - 1.28. $sht(name) usage + 1.28. $ulc(name) usage Chapter 1. Admin Guide @@ -786,7 +786,7 @@ reg_free_contacts("callee"); The pseudo-variable accepts positive index value to access a specific contact record. - Example 1.28. $sht(name) usage + Example 1.28. $ulc(name) usage ... if(reg_fetch_contacts("location", "$fu", "caller")) { diff --git a/modules_k/registrar/doc/registrar_admin.xml b/modules_k/registrar/doc/registrar_admin.xml index db28d6a..08bf610 100644 --- a/modules_k/registrar/doc/registrar_admin.xml +++ b/modules_k/registrar/doc/registrar_admin.xml @@ -1074,7 +1074,7 @@ reg_free_contacts("callee"); </para> <example> - <title><function moreinfo="none">$sht(name)</function> usage</title> + <title><function moreinfo="none">$ulc(name)</function> usage</title> <programlisting format="linespecific"> ... if(reg_fetch_contacts("location", "$fu", "caller"))

14 years, 9 months

git:kamailio_3.0: utils/sercmd: Fixed getopt() missing param

by Henning Westerholt

Module: sip-router Branch: kamailio_3.0 Commit: 6f62f7fad5a2c726d95ac6c47129494bbabc11b1 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=6f62f7f… Author: Marius Zbihlei <marius.zbihlei(a)1and1.ro> Committer: Henning Westerholt <henning.westerholt(a)1und1.de> Date: Thu Jan 21 17:32:42 2010 +0200 utils/sercmd: Fixed getopt() missing param Getopt was missing the -U param (cherry picked from commit 7c701df1be3d71afe49e7d017a90fa10c081b790) --- utils/sercmd/sercmd.c | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/utils/sercmd/sercmd.c b/utils/sercmd/sercmd.c index ada5ff6..1f1a721 100644 --- a/utils/sercmd/sercmd.c +++ b/utils/sercmd/sercmd.c @@ -1885,7 +1885,7 @@ int main(int argc, char** argv) port_no=0; sock_type=UNIXS_SOCK; opterr=0; - while((c=getopt(argc, argv, "Vhs:D:R:vf:"))!=-1){ + while((c=getopt(argc, argv, "UVhs:D:R:vf:"))!=-1){ switch(c){ case 'V': printf("version: %s\n", version);

14 years, 9 months

git:kamailio_3.0: ldap(k): fix ldapsearch with empty filter

by Henning Westerholt

Module: sip-router Branch: kamailio_3.0 Commit: de23564c9cea377e166d1fa462a5d33ab02cd7c8 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=de23564… Author: Henning Westerholt <henning.westerholt(a)1und1.de> Committer: Henning Westerholt <henning.westerholt(a)1und1.de> Date: Thu Jan 21 19:26:08 2010 +0100 ldap(k): fix ldapsearch with empty filter * fix ldapsearch with empty filter * When in routing script ldapsearch() is executed on LDAP query URL without the ‘filter’ section, request forming fails: ERROR: ldap [ldap_api_fn.c:193]: vsnprintf failed * Workaround for administrators can be filling filter section with ‘(objectclass=*)’, what is anyway substituted by ldap library to request in case filter parameter set to NULL. * Please notice that va_end() call is missing in original code. * Patch FS#23 from andrey dot utkin at wildix dot com (cherry picked from commit 73655cc83851f1f406ce23b8d6130632d731ef2d) --- modules_k/ldap/ldap_api_fn.c | 44 +++++++++++++++++++++++------------------ 1 files changed, 25 insertions(+), 19 deletions(-) diff --git a/modules_k/ldap/ldap_api_fn.c b/modules_k/ldap/ldap_api_fn.c index c2176fc..20fd869 100644 --- a/modules_k/ldap/ldap_api_fn.c +++ b/modules_k/ldap/ldap_api_fn.c @@ -158,6 +158,7 @@ int ldap_params_search( { int rc; static char filter_str[LDAP_MAX_FILTER_LEN]; + char *filter_ptr = NULL; va_list filter_vars; /* @@ -174,24 +175,29 @@ int ldap_params_search( return -1; } - /* - * vsnprintf - */ - va_start(filter_vars, _filter); - rc = vsnprintf(filter_str, (size_t)LDAP_MAX_FILTER_LEN, _filter, - filter_vars); - if (rc >= LDAP_MAX_FILTER_LEN) - { - LM_ERR( "[%s]: filter string too long (len [%d], max len [%d])\n", - _lds_name, - rc, - LDAP_MAX_FILTER_LEN); - return -1; - } - else if (rc < 0) - { - LM_ERR("vsnprintf failed\n"); - return -1; + if (_filter) { + /* + * vsnprintf + */ + va_start(filter_vars, _filter); + rc = vsnprintf(filter_str, (size_t)LDAP_MAX_FILTER_LEN, _filter, + filter_vars); + va_end(filter_vars); + + if (rc >= LDAP_MAX_FILTER_LEN) + { + LM_ERR( "[%s]: filter string too long (len [%d], max len [%d])\n", + _lds_name, + rc, + LDAP_MAX_FILTER_LEN); + return -1; + } + else if (rc < 0) + { + LM_ERR("vsnprintf failed\n"); + return -1; + } + filter_ptr = filter_str; } /* @@ -200,7 +206,7 @@ int ldap_params_search( if (lds_search(_lds_name, _dn, _scope, - filter_str, + filter_ptr, _attrs, NULL, _ld_result_count,

14 years, 9 months

git:master: modules_k/ registrar Updated documentation to reflect ser cfg framework integration

by Marius Zbihlei

Module: sip-router Branch: master Commit: 8b2457cf44077cf8b09e282aea4bdc73476e8145 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8b2457c… Author: Marius Zbihlei <marius.zbihlei(a)1and1.ro> Committer: Marius Zbihlei <marius.zbihlei(a)1and1.ro> Date: Mon Mar 8 16:11:05 2010 +0200 modules_k/registrar Updated documentation to reflect ser cfg framework integration --- modules_k/registrar/README | 128 ++++++++++++++------------- modules_k/registrar/doc/registrar_admin.xml | 18 +++-- 2 files changed, 78 insertions(+), 68 deletions(-) Diff: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commitdiff;h=8b2…

14 years, 9 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, 9 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, 9 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, 9 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, 9 months

← Newer
1
...
26
27
28
29
30
31
32
...
36
Older →

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

sr-dev March 2010