sr-dev

sr-dev@lists.kamailio.org

44307 discussions

git:master: Added note on latent operations to xhttp docs in order to help

by Alex Balashov

Module: sip-router Branch: master Commit: 6bd9d264202716617819efc3a551f04ac21f2040 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=6bd9d26… Author: Alex Balashov <abalashov(a)evaristesys.com> Committer: Alex Balashov <abalashov(a)evaristesys.com> Date: Wed Oct 6 05:19:11 2010 -0400 Added note on latent operations to xhttp docs in order to help educate users preemptively about a common pitfall that many implementors of web service interfaces inside Kamailio/sip-router are likely to make. --- modules/xhttp/README | 94 +++++++++++++++++++++++++----------- modules/xhttp/doc/xhttp.xml | 5 ++ modules/xhttp/doc/xhttp_admin.xml | 35 ++++++++++++++ 3 files changed, 105 insertions(+), 29 deletions(-) diff --git a/modules/xhttp/README b/modules/xhttp/README index 9619be5..edde90f 100644 --- a/modules/xhttp/README +++ b/modules/xhttp/README @@ -10,6 +10,12 @@ Daniel-Constantin Mierla <miconda(a)gmail.com> +Edited by + +Alex Balashov + + <abalashov(a)evaristesys.com> + Copyright © 2010 asipto.com __________________________________________________________________ @@ -18,19 +24,20 @@ Daniel-Constantin Mierla 1. Admin Guide 1. Overview - 2. Dependencies + 2. Note on Latency + 3. Dependencies - 2.1. Kamailio Modules - 2.2. External Libraries or Applications + 3.1. Kamailio Modules + 3.2. External Libraries or Applications - 3. Exported Parameters + 4. Exported Parameters - 3.1. url_skip (str) - 3.2. url_match (str) + 4.1. url_skip (str) + 4.2. url_match (str) - 4. Exported Functions + 5. Exported Functions - 4.1. xhttp_reply(code, reason, ctype, body) + 5.1. xhttp_reply(code, reason, ctype, body) List of Examples @@ -43,19 +50,20 @@ Chapter 1. Admin Guide Table of Contents 1. Overview - 2. Dependencies + 2. Note on Latency + 3. Dependencies - 2.1. Kamailio Modules - 2.2. External Libraries or Applications + 3.1. Kamailio Modules + 3.2. External Libraries or Applications - 3. Exported Parameters + 4. Exported Parameters - 3.1. url_skip (str) - 3.2. url_match (str) + 4.1. url_skip (str) + 4.2. url_match (str) - 4. Exported Functions + 5. Exported Functions - 4.1. xhttp_reply(code, reason, ctype, body) + 5.1. xhttp_reply(code, reason, ctype, body) 1. Overview @@ -70,28 +78,56 @@ Chapter 1. Admin Guide use of $ru will raise errors since the structure of an HTTP URL is not compatible with that of a SIP URI. -2. Dependencies +2. Note on Latency + + Because HTTP requests in xhttp are handled by the same, finite number + of SIP worker processes that operate on SIP messages, the same general + principles regarding script execution speed and throughput should be + observed by the writer in event_route[xhttp:request] as in any other + part of the route script. + + For example, if you initiate a database query in the HTTP request route + that takes a long time to return rows, the SIP worker process in which + the request is handled will be blocked for that time and unable to + process other SIP messages. In most typical installations, there are + only a few of these worker processes running. + + Therefore, it is highly inadvisable to execute particularly slow things + in the event_route[xhttp:request], because the request is not handled + in an asynchronous manner or otherwise peripherally to general SIP + processing. SIP worker threads will block, pending the outcome of the + event route just like any other config script route. + + This is no more or less true for xhttp than it is for any other block + of script in any other scenario, and does not warrant any extraordinary + concern. It nevertheless bears mention here because some processes with + embedded HTTP servers have the request processing take place "outside" + of the main synchronous event sequence, whether by creating separate + threads or by some other asynchronous handling. That is not the case + with xhttp. + +3. Dependencies - 2.1. Kamailio Modules - 2.2. External Libraries or Applications + 3.1. Kamailio Modules + 3.2. External Libraries or Applications -2.1. Kamailio Modules +3.1. Kamailio Modules The following modules must be loaded before this module: * sl - stateless reply. -2.2. External Libraries or Applications +3.2. External Libraries or Applications The following libraries or applications must be installed before running Kamailio with this module loaded: * None -3. Exported Parameters +4. Exported Parameters - 3.1. url_skip (str) - 3.2. url_match (str) + 4.1. url_skip (str) + 4.2. url_match (str) -3.1. url_skip (str) +4.1. url_skip (str) Regular expression to match the HTTP URL. If there is a match, then event route is not executed. @@ -103,7 +139,7 @@ Chapter 1. Admin Guide modparam("xhttp", "url_skip", "^/RPC2") ... -3.2. url_match (str) +4.2. url_match (str) Regular expression to match the HTTP URL. If there is no match, then event route is not executed. This check is done after url_skip, so if @@ -117,11 +153,11 @@ modparam("xhttp", "url_skip", "^/RPC2") modparam("xhttp", "url_match", "^/sip/") ... -4. Exported Functions +5. Exported Functions - 4.1. xhttp_reply(code, reason, ctype, body) + 5.1. xhttp_reply(code, reason, ctype, body) -4.1. xhttp_reply(code, reason, ctype, body) +5.1. xhttp_reply(code, reason, ctype, body) Send back a reply with content-type and body. diff --git a/modules/xhttp/doc/xhttp.xml b/modules/xhttp/doc/xhttp.xml index b64dd0f..bc915e5 100644 --- a/modules/xhttp/doc/xhttp.xml +++ b/modules/xhttp/doc/xhttp.xml @@ -23,6 +23,11 @@ <surname>Mierla</surname> <email>miconda(a)gmail.com</email> </editor> + <editor> + <firstname>Alex</firstname> + <surname>Balashov</surname> + <email>abalashov(a)evaristesys.com</email> + </editor> </authorgroup> <copyright> <year>2010</year> diff --git a/modules/xhttp/doc/xhttp_admin.xml b/modules/xhttp/doc/xhttp_admin.xml index 44f7ef0..0760a5b 100644 --- a/modules/xhttp/doc/xhttp_admin.xml +++ b/modules/xhttp/doc/xhttp_admin.xml @@ -29,6 +29,41 @@ of an HTTP URL is not compatible with that of a SIP URI. </para> </section> + + <section> + <title>Note on Latency</title> + <para> + Because HTTP requests in <emphasis>xhttp</emphasis> are handled + by the same, finite number of SIP worker processes that operate on + SIP messages, the same general principles regarding script execution + speed and throughput should be observed by the writer in + <emphasis>event_route[xhttp:request]</emphasis> as in any other + part of the route script. + </para> + <para> + For example, if you initiate a database query in the HTTP request route + that takes a long time to return rows, the SIP worker process in which + the request is handled will be blocked for that time and unable to + process other SIP messages. In most typical installations, there are + only a few of these worker processes running. + </para> + <para> + Therefore, it is highly inadvisable to execute particularly slow things in the + <emphasis>event_route[xhttp:request]</emphasis>, because the request is not + handled in an asynchronous manner or otherwise peripherally to general + SIP processing. SIP worker threads will block, pending the outcome of the + event route just like any other config script route. + </para> + <para> This is no more or less true for <emphasis>xhttp</emphasis> than it is for + any other block of script in any other scenario, and does not warrant any + extraordinary concern. It nevertheless bears mention here because some + processes with embedded HTTP servers have the request processing take place + "outside" of the main synchronous event sequence, whether by creating + separate threads or by some other asynchronous handling. That is not the + case with <emphasis>xhttp</emphasis>. + </para> + </section> + <section> <title>Dependencies</title> <section>

14 years, 4 months

git:master: Added regenerated README for 'debugger' as well, because that seems to

by Alex Balashov

Module: sip-router Branch: master Commit: cdd414350ab425c916ddc934fd444dc6700b08df URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=cdd4143… Author: Alex Balashov <abalashov(a)evaristesys.com> Committer: Alex Balashov <abalashov(a)evaristesys.com> Date: Wed Oct 6 02:33:44 2010 -0400 Added regenerated README for 'debugger' as well, because that seems to be the convention for doc changes. Is it? --- modules/debugger/README | 61 ++++++++++++++++++++++++----------------------- 1 files changed, 31 insertions(+), 30 deletions(-) diff --git a/modules/debugger/README b/modules/debugger/README index 8e55a64..4725d77 100644 --- a/modules/debugger/README +++ b/modules/debugger/README @@ -91,8 +91,8 @@ Chapter 1. Admin Guide 1. Overview This module provides an interactive config file debugger. It can print - the trace of config execution for a SIP message to log and set - breakpoints on every config action, allowing to execute step by step + a trace of config execution for a SIP message to log and set + breakpoints on every config action, allowing step-by-step execution of the config. Debugging can be done from local or remote host via RPC interface @@ -105,9 +105,9 @@ Chapter 1. Admin Guide Also the config running trace can be enabled/disabled at runtime. When the SIP router process is stopped at a breakpoint, you can - investigate the values of any pseudo-varaibles. Note that some of - pseudo-variables may produce memory leak, that is planned to fix in the - future (here falls pseudo-variables with dynamic name such as htable, + investigate the values of any pseudo-variables. Note that some of + pseudo-variables may produce memory leaks; a fix is planned in the + future (here fall pseudo-variables with dynamic name such as htable, sqlops). References to SIP message, avps, headers, script and shared variables are safe. @@ -164,7 +164,7 @@ modparam("debugger", "breakpoint", 1) 3.3. log_level (int) - What log level to be used to print module specific messages. + What log level is to be used to print module-specific messages. Default value is “-1” (L_ERR). @@ -175,7 +175,7 @@ modparam("debugger", "log_level", 1) 3.4. log_facility (str) - What log facility to be used to print module specific messages. + What log facility is to be used to print module-specific messages. Default value is “NULL” (default from core). @@ -186,7 +186,7 @@ modparam("debugger", "log_facility", "LOG_DAEMON") 3.5. log_prefix (str) - String to print before any module specific messages. + String to print before any module-specific messages. Default value is “*** cfgtrace:”. @@ -198,9 +198,9 @@ modparam("debugger", "log_prefix", "from-debugger-with-love:") 3.6. step_usleep (int) Microseconds to sleep before checking for new commands when waiting at - breakpoint + breakpoint. - Default value is “100000” (that is 0.1sec). + Default value is “100000” (that is 0.1 sec). Example 1.6. Set step_usleep parameter ... @@ -211,7 +211,7 @@ modparam("debugger", "step_usleep", 500000) How many sleeps of 'step_usleep' the RPC process performs when waiting for a reply from worker process before responding to RPC. This avoids - blocking RPC process for ever in case the worker process 'forgets' to + blocking RPC process forever in case the worker process 'forgets' to write back a reply. Default value is “200”. @@ -227,11 +227,12 @@ modparam("debugger", "step_loops", 100) 4.1. dbg_breakpoint(mode) - Anchor a breakpoint at that line in config. Mode specifies whether the - breakpoint is enabled (1) or disabled (0) at startup. + Anchor a breakpoint at the current line of the config (the one on which + this function is called). The 'mode' specifies whether the breakpoint + is enabled (1) or disabled (0) at startup. Note that this version does not export this anchors to RPC for - interactive debugging (temporary disabled). + interactive debugging (temporarily disabled). Example 1.8. dbg_breakpoint usage ... @@ -252,10 +253,10 @@ if($si=="10.0.0.10") Name: dbg.list Parameters: - * _pid_ : pid for which to list the details. If it missing, then will - print for all processes. + * _pid_ : pid for which to list the details. If 'pid' is omitted then + will print for all processes. - Examples for using with sercmd: + Examples of use with sercmd: dbg.ls dbg.ls 1234 @@ -266,10 +267,10 @@ if($si=="10.0.0.10") Name: dbg.trace Parameters: - * _cmd_ : inner command can be 'on' or 'off' to enable or disable the - tracing for one or all processe. - * _pid_ : pid for which to list the details. If it missing, then will - print for all processes. + * _cmd_ : inner command can be 'on' or 'off' to enable or disable + tracing for one or all processes. + * _pid_ : pid for which to list the details. If 'pid' is omitted, + then it will print details for all processes. Examples for using with sercmd: dbg.trace on @@ -285,8 +286,8 @@ if($si=="10.0.0.10") Parameters: * _cmd_ : inner command, see next section for the list of available values. - * _pid_ : pid for which to apply the inner command. If it is missing, - then will be applied for all processes. + * _pid_ : pid for which to apply the inner command. If 'pid' is + omitted, then the inner command will be applied to all processes. * _params_ : extra params specific for each inner command. Inner commands: @@ -321,9 +322,9 @@ if($si=="10.0.0.10") message. Just enable cfg running trace, send the message and watch the logs. - Another typical usage is to do interactive debugging and run - step-by-step each line in routing blocks of config file for a - particular SIP message. + Another typical usage is to do interactive debugging and run each line + of the route blocks of the config file step-by-step for a particular + SIP message. You need to connect using sercmd (or other RPC client) to SIP Router. Then you can enable cfg breakpoints and send the SIP message. One @@ -383,7 +384,7 @@ sercmd> dbg.bp move 6402 200 ok ... - Running config trace looks like: + Running the config trace looks like: ... 9(6285) ERROR: *** cfgtrace: c=[/etc/kamailio/debugger.cfg] l=368 a=6 n=route 9(6285) ERROR: *** cfgtrace: c=[/etc/kamailio/debugger.cfg] l=461 a=17 n=if @@ -432,8 +433,8 @@ set 9(6285) ERROR: *** cfgtrace: c=[/etc/kamailio/debugger.cfg] l=516 a=3 n=exit ... - Above example is for registration with default config for version + The above example is for registration with default config for version 3.1.0, without authentication. Listed fields are: 'c' - config file; 'l' - line; 'a' - internal action id; 'n' - name of executed action. - 'ERROR' prefix is printed because these messages were sent to L_ERR log - level. + 'ERROR' prefix is printed because these messages were sent to the L_ERR + log level.

14 years, 4 months

3.0.3: sqlops

by Olle E. Johansson

I compiled 3.0.3 on a Debian system and tried using sqlops. The module loads ok, but in debugging I only see it registering the modparam "sqlcon" name. Using any function in the module results in errors in parsing the config file. "Unknown command, missing loadmodule?" Anyone else that have seen this? /O

14 years, 4 months

xhttp question

by Alex Balashov

If the HTTP responses are implemented by using the SIP parser + fake Via header to appease it, is it appropriate to conclude that the same SIP worker processes are used to answer HTTP queries as ones used to process SIP messages? Or is there some more asynchronous mechanism, external pthreads, etc. used to handle HTTP requests? If SIP workers are used, I will add a note in the xhttp documentation reminding users not to do anything in their xhttp event-route that is particularly latent, and observe the same lean throughput principles as in normal route script. Otherwise, little HTTP requests sent to the server can block SIP worker threads. -- Alex Balashov - Principal Evariste Systems LLC 1170 Peachtree Street 12th Floor, Suite 1200 Atlanta, GA 30309 Tel: +1-678-954-0670 Fax: +1-404-961-1892 Web: http://www.evaristesys.com/

14 years, 4 months

kamctl error for lcr commands

by Klaus Feichtinger

Hello, I have been searching for the error in KAMCTL regarding lcr commands in the new RC1 version. The files "kamctl.base" and "kamctl" in the directory "utils/kamctl" should be corrected, because following error is included by now: =========== KAMCTL.BASE =========== 1) wrong table names in kamctl.base 2) wrong column definition (grp_id is no longer present) excerpt: [...] # lcr tables if [ -z "$LCR_TABLE" ] ; then LCR_TABLE=lcr fi LCR_ID_COLUMN=lcr_id LCR_PREFIX_COLUMN=prefix LCR_GRPID_COLUMN=grp_id # gw table if [ -z "$GW_TABLE" ] ; then GW_TABLE=gw fi [...] ======= KAMCTL ======= 1) the DB-queries are not up to date, because the table structure has changed; now three tables instead of two are used; the GRPID_column is no longer valid a.s.o. 2) I have not found any declaration of RPCCMD within the sourcecode - so these functions are not supported now excerpt: [...] ### LCR management # lcr() { case $1 in show_gws) require_dbengine mecho "lcr gateways" QUERY="select * FROM $GW_TABLE ORDER BY $LCR_ID_COLUMN, $LCR_GW_GRPID_COLUMN; " $DBROCMD "$QUERY" ;; show_routes) require_dbengine mecho "lcr routes" QUERY="select * FROM $LCR_TABLE ORDER BY $LCR_ID_COLUMN, $LCR_PREFIX_COLUMN; " $DBROCMD "$QUERY" ;; reload) $RPCCMD lcr.reload ;; dump_gws) $RPCCMD lcr.dump_gws ;; dump_routes) $RPCCMD lcr.dump_lcrs ;; [...] regards, Klaus Feichtinger

14 years, 4 months

git:master: One more fix to xhttp documentation.

by Alex Balashov

Module: sip-router Branch: master Commit: fc07c55d2c7f549feeb0eb7cb4f98a1180614dda URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=fc07c55… Author: Alex Balashov <abalashov(a)evaristesys.com> Committer: Alex Balashov <abalashov(a)evaristesys.com> Date: Wed Oct 6 03:15:26 2010 -0400 One more fix to xhttp documentation. --- modules/xhttp/README | 5 +++-- modules/xhttp/doc/xhttp_admin.xml | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/modules/xhttp/README b/modules/xhttp/README index 0133f15..9619be5 100644 --- a/modules/xhttp/README +++ b/modules/xhttp/README @@ -66,8 +66,9 @@ Chapter 1. Admin Guide The xmlrpc module uses the same concept. xHTTP module offers a generic HTTP handling way, by calling event_route[xhttp:request] in your - config. You can check the HTTP URI via config variable $hu. Note that - $ru will raise errors since URO is not valid for SIP. + config. You can check the HTTP URL via config variable $hu. Note that + use of $ru will raise errors since the structure of an HTTP URL is not + compatible with that of a SIP URI. 2. Dependencies diff --git a/modules/xhttp/doc/xhttp_admin.xml b/modules/xhttp/doc/xhttp_admin.xml index ee735ca..44f7ef0 100644 --- a/modules/xhttp/doc/xhttp_admin.xml +++ b/modules/xhttp/doc/xhttp_admin.xml @@ -24,8 +24,9 @@ <para> The xmlrpc module uses the same concept. xHTTP module offers a generic HTTP handling way, by calling event_route[xhttp:request] - in your config. You can check the HTTP URI via config variable - $hu. Note that $ru will raise errors since URO is not valid for SIP. + in your config. You can check the HTTP URL via config variable + $hu. Note that use of $ru will raise errors since the structure + of an HTTP URL is not compatible with that of a SIP URI. </para> </section> <section>

14 years, 4 months

git:master: Some typo fixes and minor tweaks to xmlops docs.

by Alex Balashov

Module: sip-router Branch: master Commit: 45b3f656c69ad43e6f9cf072ce3805dfcfdd49b4 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=45b3f65… Author: Alex Balashov <abalashov(a)evaristesys.com> Committer: Alex Balashov <abalashov(a)evaristesys.com> Date: Wed Oct 6 03:10:47 2010 -0400 Some typo fixes and minor tweaks to xmlops docs. --- modules/xmlops/doc/functions.xml | 2 +- modules/xmlops/doc/xmlops.xml | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/xmlops/doc/functions.xml b/modules/xmlops/doc/functions.xml index 8f1fc49..36daac0 100644 --- a/modules/xmlops/doc/functions.xml +++ b/modules/xmlops/doc/functions.xml @@ -11,7 +11,7 @@ </title> <para> Pseudo-variable for XML document operations using xpath syntax. For - more see the Peudo-Variables Cookbook. + more see the Pseudo-Variables Cookbook. </para> <example> <title><function>xml</function> usage</title> diff --git a/modules/xmlops/doc/xmlops.xml b/modules/xmlops/doc/xmlops.xml index fe8a9a1..94fc4b8 100644 --- a/modules/xmlops/doc/xmlops.xml +++ b/modules/xmlops/doc/xmlops.xml @@ -23,7 +23,7 @@ <section id="xmlops.overview"> <title>Overview</title> <para> - This is a module implementing funtions and pseudo-variables for + This is a module implementing functions and pseudo-variables for XML operations. </para> </section> @@ -51,8 +51,8 @@ <itemizedlist> <listitem> <para> - <emphasis>libxml</emphasis> - for compilaiton is needed the devel - vesion as well. + <emphasis>libxml</emphasis> - for compilation from source, the + development headers from this library are needed as well. </para> </listitem> </itemizedlist>

14 years, 4 months

git:master: Fixed some typos in xhttp module docs.

by Alex Balashov

Module: sip-router Branch: master Commit: b520501258d59192746b1771e6827da543963189 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b520501… Author: Alex Balashov <abalashov(a)evaristesys.com> Committer: Alex Balashov <abalashov(a)evaristesys.com> Date: Wed Oct 6 03:08:05 2010 -0400 Fixed some typos in xhttp module docs. --- modules/xhttp/README | 15 ++++++++------- modules/xhttp/doc/xhttp_admin.xml | 12 ++++++------ 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/modules/xhttp/README b/modules/xhttp/README index ae772fd..0133f15 100644 --- a/modules/xhttp/README +++ b/modules/xhttp/README @@ -59,14 +59,15 @@ Chapter 1. Admin Guide 1. Overview - This module provides a basic HTTP/1.0 server functionaly inside SIP - server. SIP and HTTP are very similar protocols, practically the SIP - parser can handle easy HTTP requests just by adding a fake Via header. + This module provides basic HTTP/1.0 server functionality inside SIP + Router. SIP and HTTP are very similar protocols, so, practically, the + SIP parser can easily handle HTTP requests just by adding a fake Via + header. The xmlrpc module uses the same concept. xHTTP module offers a generic HTTP handling way, by calling event_route[xhttp:request] in your config. You can check the HTTP URI via config variable $hu. Note that - $ru will rise errors since URO is not valid for SIP. + $ru will raise errors since URO is not valid for SIP. 2. Dependencies @@ -91,8 +92,8 @@ Chapter 1. Admin Guide 3.1. url_skip (str) - Regular expression to match the HTTP URL. If there is match, then event - route is not executed. + Regular expression to match the HTTP URL. If there is a match, then + event route is not executed. Default value is null (don't skip). @@ -103,7 +104,7 @@ modparam("xhttp", "url_skip", "^/RPC2") 3.2. url_match (str) - Regular expression to match the HTPP URL. If there is no match, then + Regular expression to match the HTTP URL. If there is no match, then event route is not executed. This check is done after url_skip, so if both url_skip and url_match would match then the event route is not executed (url_skip has higher priority). diff --git a/modules/xhttp/doc/xhttp_admin.xml b/modules/xhttp/doc/xhttp_admin.xml index 7128d34..ee735ca 100644 --- a/modules/xhttp/doc/xhttp_admin.xml +++ b/modules/xhttp/doc/xhttp_admin.xml @@ -16,16 +16,16 @@ <section> <title>Overview</title> <para> - This module provides a basic HTTP/1.0 server functionaly inside SIP - server. SIP and HTTP are very similar protocols, practically the - SIP parser can handle easy HTTP requests just by adding a fake + This module provides basic HTTP/1.0 server functionality inside SIP + Router. SIP and HTTP are very similar protocols, so, practically, the + SIP parser can easily handle HTTP requests just by adding a fake Via header. </para> <para> The xmlrpc module uses the same concept. xHTTP module offers a generic HTTP handling way, by calling event_route[xhttp:request] in your config. You can check the HTTP URI via config variable - $hu. Note that $ru will rise errors since URO is not valid for SIP. + $hu. Note that $ru will raise errors since URO is not valid for SIP. </para> </section> <section> @@ -63,7 +63,7 @@ <section> <title><varname>url_skip</varname> (str)</title> <para> - Regular expression to match the HTTP URL. If there is match, + Regular expression to match the HTTP URL. If there is a match, then event route is not executed. </para> <para> @@ -83,7 +83,7 @@ modparam("xhttp", "url_skip", "^/RPC2") <section> <title><varname>url_match</varname> (str)</title> <para> - Regular expression to match the HTPP URL. If there is no match, + Regular expression to match the HTTP URL. If there is no match, then event route is not executed. This check is done after url_skip, so if both url_skip and url_match would match then the event route is not executed (url_skip has higher priority).

14 years, 4 months

git:master: Some minor tweaks to documentation for textopsx.

by Alex Balashov

Module: sip-router Branch: master Commit: b495e34e507517cfac8ed2c921642c38b0f0262a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b495e34… Author: Alex Balashov <abalashov(a)evaristesys.com> Committer: Alex Balashov <abalashov(a)evaristesys.com> Date: Wed Oct 6 03:04:09 2010 -0400 Some minor tweaks to documentation for textopsx. --- modules/textopsx/README | 13 ++++++------- modules/textopsx/doc/functions.xml | 12 ++++++------ 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/modules/textopsx/README b/modules/textopsx/README index cece6b5..73d894b 100644 --- a/modules/textopsx/README +++ b/modules/textopsx/README @@ -28,11 +28,10 @@ Daniel-Constantin Mierla 1.2.1. msg_apply_changes() - Use this function to apply changes done on SIP request content. Be - careful when using this function -- due to special handling of changes - done to SIM message buffer so far, using this function might change the - behaviour of your config as it was so far -- do test properly your - config! + Use this function to apply changes performed on SIP request content. Be + careful when using this function; due to special handling of changes + done to SIP message buffer so far, using this function might change the + behaviour of your config. Do test your config properly! This function can be used from REQUEST_ROUTE. @@ -51,8 +50,8 @@ if(msg_apply_changes()) 1.2.2. change_reply_status(code, reason) - Change the status code and reason phrase of a SIP reply in - onreply_route. + Intercept a SIP reply (in an onreply_route) and change its status code + and reason phrase prior to propogating it. Meaning of the parameters is as follows: * code - Status code. diff --git a/modules/textopsx/doc/functions.xml b/modules/textopsx/doc/functions.xml index bc0fc38..9d7d4f6 100644 --- a/modules/textopsx/doc/functions.xml +++ b/modules/textopsx/doc/functions.xml @@ -10,11 +10,10 @@ <function moreinfo="none">msg_apply_changes()</function> </title> <para> - Use this function to apply changes done on SIP request content. Be - careful when using this function -- due to special handling of changes - done to SIM message buffer so far, using this function might change - the behaviour of your config as it was so far -- do test properly - your config! + Use this function to apply changes performed on SIP request content. Be + careful when using this function; due to special handling of changes + done to SIP message buffer so far, using this function might change + the behaviour of your config. Do test your config properly! </para> <para> This function can be used from REQUEST_ROUTE. @@ -42,7 +41,8 @@ if(msg_apply_changes()) <function>change_reply_status(code, reason)</function> </title> <para> - Change the status code and reason phrase of a SIP reply in onreply_route. + Intercept a SIP reply (in an onreply_route) and change its status code + and reason phrase prior to propogating it. </para> <para>Meaning of the parameters is as follows:</para> <itemizedlist>

14 years, 4 months

git:master: Added some clarifications and additional information to the ' geoip' docs.

by Alex Balashov

Module: sip-router Branch: master Commit: 8c5375ff34b111807873cf6007886219d99d34ce URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8c5375f… Author: Alex Balashov <abalashov(a)evaristesys.com> Committer: Alex Balashov <abalashov(a)evaristesys.com> Date: Wed Oct 6 02:51:23 2010 -0400 Added some clarifications and additional information to the 'geoip' docs. --- modules/geoip/README | 37 ++++++++++++++++++++++++---------- modules/geoip/doc/geoip_admin.xml | 39 ++++++++++++++++++++++++++++-------- 2 files changed, 56 insertions(+), 20 deletions(-) diff --git a/modules/geoip/README b/modules/geoip/README index 01c3d9d..11c8c73 100644 --- a/modules/geoip/README +++ b/modules/geoip/README @@ -10,7 +10,7 @@ Daniel-Constantin Mierla <miconda(a)gmail.com> - Copyright � 2010 Daniel-Constantin Mierla (asipto.com) + Copyright © 2010 Daniel-Constantin Mierla (asipto.com) __________________________________________________________________ Table of Contents @@ -60,12 +60,26 @@ Chapter 1. Admin Guide 1. Overview - The module loads exports a new class of pseudo-variables - - $gip(pvc=>key) - to access results upon a query against Max Mind GeoIP - database. + This module allows real-time queries against the Max Mind GeoIP + database to be performed from the config script. + + The Max Mind GeoIP database is a map of IP network address assignments + to geographical locales that can be useful -- though approximate -- in + identifying the physical location with which an IP host address is + associated on a relatively granular level. + + This database itself can be obtained on a free or commercial basis + here. The library that interfaces with the Max Mind API, as well as + scripts to automate downloading of the on-disk version of the + open-source database is also packaged by the Debian Linux distribution + and its derivatives as libgeoip, and probably by other distributions as + well. + + This module exports a new class of pseudo-variables - $gip(pvc=>key) - + to enable access to the results of a query to the database. Many queries can be done and store results in different containers to - be able to use in parallel. Database is loaded at startup in chache. + be able to use in parallel. Database is loaded at startup in cache. 2. Dependencies @@ -89,9 +103,9 @@ Chapter 1. Admin Guide 3.1. path (string) - Path to GeoIP database file. + Path to the GeoIP database file. - Default value is "null". + Default value is “null”. Example 1.1. Set path parameter ... @@ -104,8 +118,8 @@ modparam("geoip", "path", "/usr/local/share/GeoLiteCity.dat") 4.1. geoip_match(ipaddr, pvc) - Match ipaddr against GeoIP database and set the pvc container. The - function has to be called before accessing any $gip(pvc=>key). + Match ipaddr against the GeoIP database and set the pvc container. The + function has to be called before accessing a key via: $gip(pvc=>key). Example 1.2. geoip_match usage ... @@ -115,8 +129,9 @@ if(geoip_match("$si", "src")) 5. Exported pseudo-variables - * $gip(pvc=>key) - pvc is second parameter of geoip_match() and key - can be: + * $gip(pvc=>key) - pvc is an identifier for this query result; it is + designated by the second parameter of geoip_match(). The key can be + one of the following: + cc - country code + tz - time zone + zip - postal code diff --git a/modules/geoip/doc/geoip_admin.xml b/modules/geoip/doc/geoip_admin.xml index 89d2ede..b8c9f17 100644 --- a/modules/geoip/doc/geoip_admin.xml +++ b/modules/geoip/doc/geoip_admin.xml @@ -17,13 +17,32 @@ <section> <title>Overview</title> <para> - The module loads exports a new class of pseudo-variables - - $gip(pvc=>key) - to access results upon a query against Max Mind - GeoIP database. + This module allows real-time queries against the Max Mind GeoIP + database to be performed from the config script. + </para> + <para> + The Max Mind GeoIP database is a map of IP network address assignments + to geographical locales that can be useful -- though approximate -- + in identifying the physical location with which an IP host address + is associated on a relatively granular level. + </para> + <para> + This database itself can be obtained on a free or commercial basis + <ulink url="http://www.maxmind.com/app/ip-location">here</ulink>. The + library that interfaces with the Max Mind API, as well as scripts to + automate downloading of the on-disk version of the open-source + database is also packaged by the Debian Linux distribution and + its derivatives as <emphasis>libgeoip</emphasis>, and probably by + other distributions as well. + </para> + <para> + This module exports a new class of pseudo-variables - + $gip(pvc=>key) - to enable access to the results of a query to the + database. </para> <para> Many queries can be done and store results in different containers to - be able to use in parallel. Database is loaded at startup in chache. + be able to use in parallel. Database is loaded at startup in cache. </para> </section> <section> @@ -61,7 +80,7 @@ <section> <title><varname>path</varname> (string)</title> <para> - Path to GeoIP database file. + Path to the GeoIP database file. </para> <para> <emphasis> @@ -87,8 +106,8 @@ modparam("geoip", "path", "/usr/local/share/GeoLiteCity.dat") <function moreinfo="none">geoip_match(ipaddr, pvc)</function> </title> <para> - Match ipaddr against GeoIP database and set the pvc container. The - function has to be called before accessing any $gip(pvc=>key). + Match ipaddr against the GeoIP database and set the pvc container. The + function has to be called before accessing a key via: $gip(pvc=>key). </para> <example> <title><function>geoip_match</function> usage</title> @@ -107,8 +126,10 @@ if(geoip_match("$si", "src")) <title>Exported pseudo-variables</title> <itemizedlist> <listitem><para> - <emphasis>$gip(pvc=>key)</emphasis> - pvc is second - parameter of geoip_match() and key can be: + <emphasis>$gip(pvc=>key)</emphasis> - <emphasis>pvc</emphasis> is an + identifier for this query result; it is designated by the second + parameter of geoip_match(). The <emphasis>key</emphasis> can be one of + the following: </para> <itemizedlist> <listitem><para>

14 years, 4 months

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

sr-dev