@@ -34,8 +34,6 @@ Sven Knoblich

    Copyright © 2004, 2006 Voice Sistem SRL

    Copyright © 2011 1&1 Internet AG

-   Revision History

-   Revision $Revision$ $Date$

      __________________________________________________________________

    Table of Contents

@@ -892,11 +890,11 @@ modparam("acc", "log_missed_flag", 3)

    Log level at which accounting messages are issued to syslog.

-   Default value is L_NOTICE.

+   Default value is 1 (L_NOTICE).

    Example 1.12. log_level example

 ...

-modparam("acc", "log_level", 2)   # Set log_level to 2

+modparam("acc", "log_level", 2)   # Set log_level to 2 (L_INFO)

 ...

 6.13. log_facility (string)

@@ -1344,7 +1342,7 @@ modparam("acc", "cdrs_table", "acc_cdrs")

      * 0 - (default), save only unix timestamp for syslog and datetime for

        database.

      * 1 - save seconds in time_attr and microseconds in time_exten.

-     * 2 - save seconds.miliseconds in time_attr.

+     * 2 - save seconds.milliseconds in time_attr.

      * 3 - save formatted time according to time_format parameter, using

        the output of localtime().

      * 4 - save formatted time according to time_format parameter, using

@@ -1385,7 +1383,7 @@ modparam("acc", "time_attr", "seconds")

    Example 1.51. time_exten example

 ...

-modparam("acc", "time_exten", "micorsecs")

+modparam("acc", "time_exten", "microsecs")

 ...

 6.52. time_format (str)

@@ -1397,10 +1397,9 @@ redlg_setflag("1");

    Meaning of the parameters is as follows:

      * side - where to send the BYE. It can be: 'caller', 'callee', or

-       both.

+       'all' (send to both sides).

-   This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,

-   ONREPLY_ROUTE and FAILURE_ROUTE.

+   This function can be used from ANY_ROUTE.

    Example 1.61. dlg_bye usage

 ...

@@ -328,7 +328,7 @@ Chapter 1. Admin Guide

 3.1. list_file (string)

-   Path to the file with destination sets.

+   Path to the file with destination sets (destination groups).

    Default value is “/etc/kamailio/dispatcher.list” or

    “/usr/local/etc/kamailio/dispatcher.list”.

@@ -340,7 +340,7 @@ modparam("dispatcher", "list_file", "/var/run/kamailio/dispatcher.list")

 3.2. db_url (string)

-   If you want to load the sets of gateways from the database you must set

+   If you want to load the list of gateways from the database you must set

    this parameter.

    Default value is “NULL” (disable DB support).

@@ -352,7 +352,7 @@ modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database")

 3.3. table_name (string)

-   If you want to load the sets of gateways from the database you must set

+   If you want to load the list of gateways from the database you must set

    this parameter as the database name.

    Default value is “dispatcher”.

@@ -364,7 +364,7 @@ modparam("dispatcher", "table_name", "my_dispatcher")

 3.4. setid_col (string)

-   The column's name in the database storing the gateway's group id.

+   The column's name in the database storing the gateway's set (group) id.

    Default value is “setid”.

@@ -1226,8 +1226,8 @@ kamcmd dispatcher.ping_active 0

 7.1. Destination List File

    Each destination point must be on one line. First token is the set id

-   (an integer value), followed by destination address (s string value in

-   SIP URI format).

+   (an integer value, also referenced by group id), followed by

+   destination address (string value in full SIP URI format).

    Optionally, these fields can be followed by:

      * flags (listed by index - can be bitwise mask of values): 0 (value

@@ -1278,21 +1278,21 @@ setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attrs(str,opt)

    Example 1.40. dispatcher list file

 ...

-# $Id$

-# dispatcher destination sets

+#

+# dispatcher destination sets (groups)

 #

 # line format

-# setit(int) destination(sip uri) flags(int,opt) priority(int,opt) attributes(st

+# setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attributes(st

 r,opt)

 # proxies

-2 sip:127.0.0.1:5080

-2 sip:127.0.0.1:5082

+2 sip:127.0.0.1:5080;transport=tcp 0 10 class=4;prefix=448;strip=2

+2 sip:127.0.0.1:5082;px=vx 0 5 duid=abc;socket=udp:192.168.0.125:5060;pipe=p10

 # gateways

-1 sip:127.0.0.1:7070

-1 sip:127.0.0.1:7072

+1 sip:127.0.0.1:7070 0 0 duid=xyz;maxload=20

+1 sip:127.0.0.1:7072 0 5

 1 sip:127.0.0.1:7074

 ...

@@ -21,7 +21,7 @@ Richard Fuchs

         1. Overview

-              1.1. Path insertion for registrations

+              1.1. Path Insertion For Registrations

               1.2. Outbound routing to NAT'ed UACs

         2. Dependencies

@@ -44,13 +44,14 @@ Richard Fuchs

    List of Examples

-   1.1. Set use_received parameter

-   1.2. add_path usage

-   1.3. add_path(user) usage

-   1.4. add_path(user, parameters) usage

-   1.5. add_path_received() usage

-   1.6. add_path_received(user) usage

-   1.7. add_path_received(user, parameters) usage

+   1.1. Add Supported header

+   1.2. Set use_received parameter

+   1.3. add_path usage

+   1.4. add_path(user) usage

+   1.5. add_path(user, parameters) usage

+   1.6. add_path_received() usage

+   1.7. add_path_received(user) usage

+   1.8. add_path_received(user, parameters) usage

 Chapter 1. Admin Guide

@@ -58,7 +59,7 @@ Chapter 1. Admin Guide

    1. Overview

-        1.1. Path insertion for registrations

+        1.1. Path Insertion For Registrations

         1.2. Outbound routing to NAT'ed UACs

    2. Dependencies

@@ -81,7 +82,7 @@ Chapter 1. Admin Guide

 1. Overview

-   1.1. Path insertion for registrations

+   1.1. Path Insertion For Registrations

    1.2. Outbound routing to NAT'ed UACs

    This module is designed to be used at intermediate sip proxies like

@@ -91,7 +92,7 @@ Chapter 1. Admin Guide

    mechanism for evaluating this parameter in subsequent requests and to

    set the destination URI according to it.

-1.1. Path insertion for registrations

+1.1. Path Insertion For Registrations

    For registrations in a scenario like “[UAC] -> [P1] -> [REG]”, the

    "path" module can be used at the intermediate proxy P1 to insert a Path

@@ -110,6 +111,15 @@ Chapter 1. Admin Guide

        If the function is called with a username, it's included in the

        Path URI too.

+   Note that some SIP registrars may check if header Supported includes

+   'path'. It can be added in Kamailio.cfg using append_hf() from textops

+   module.

+

+   Example 1.1. Add Supported header

+...

+append_hf("Supported: path\r\n");

+...

+

 1.2. Outbound routing to NAT'ed UACs

    If the NAT'ed address of an UAC is passed to the registrar, the

@@ -152,7 +162,7 @@ Chapter 1. Admin Guide

    Default value is 0.

-   Example 1.1. Set use_received parameter

+   Example 1.2. Set use_received parameter

 ...

 modparam("path", "use_received", 1)

 ...

@@ -181,7 +191,7 @@ modparam("path", "use_received", 1)

    This function can be used from REQUEST_ROUTE.

-   Example 1.2. add_path usage

+   Example 1.3. add_path usage

 ...

 if (!add_path()) {

         sl_send_reply("503", "Internal Path Error");

@@ -199,7 +209,7 @@ if (!add_path()) {

    This function can be used from REQUEST_ROUTE.

-   Example 1.3. add_path(user) usage

+   Example 1.4. add_path(user) usage

 ...

 if (!add_path("loadbalancer")) {

         sl_send_reply("503", "Internal Path Error");

@@ -221,7 +231,7 @@ if (!add_path("loadbalancer")) {

    This function can be used from REQUEST_ROUTE.

-   Example 1.4. add_path(user, parameters) usage

+   Example 1.5. add_path(user, parameters) usage

 ...

 if (!add_path("loadbalancer", "ob")) {

         sl_send_reply("503", "Internal Path Error");

@@ -238,7 +248,7 @@ if (!add_path("loadbalancer", "ob")) {

    This function can be used from REQUEST_ROUTE.

-   Example 1.5. add_path_received() usage

+   Example 1.6. add_path_received() usage

 ...

 if (!add_path_received()) {

         sl_send_reply("503", "Internal Path Error");

@@ -255,7 +265,7 @@ if (!add_path_received()) {

    This function can be used from REQUEST_ROUTE.

-   Example 1.6. add_path_received(user) usage

+   Example 1.7. add_path_received(user) usage

 ...

 if (!add_path_received("inbound")) {

         sl_send_reply("503", "Internal Path Error");

@@ -272,7 +282,7 @@ if (!add_path_received("inbound")) {

    This function can be used from REQUEST_ROUTE.

-   Example 1.7. add_path_received(user, parameters) usage

+   Example 1.8. add_path_received(user, parameters) usage

 ...

 if (!add_path_received("inbound", "ob")) {

         sl_send_reply("503", "Internal Path Error");

@@ -369,7 +369,7 @@ kamcmd cfg.set_now_string pipelimit reply_reason "Limiting"

        ratelimit module for details on each algorithm.

      * limit - the integer or pseudovariable with the limit value.

-   This function can be used from REQUEST_ROUTE.

+   This function can be used from ANY_ROUTE.

    Example 1.12. pl_check usage

 ...

@@ -437,7 +437,8 @@ with unexpected retcode=$var(check_result)\n");

      * min - the minimum value of "Retry-After" header.

      * max - the maximum value of "Retry-After" header.

-   This function can be used from REQUEST_ROUTE.

+   This function can be used from

+   REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE|ONSEND_ROUTE.

    Example 1.13. pl_drop usage

 ...

@@ -121,7 +121,7 @@ modparam("rtimer", "timer", "name=ta;interval=10;mode=1;")

 modparam("rtimer", "exec", "timer=ta;route=8")

 route[8] {

-    xlog("timer routine: time is %TF\n");

+    xlog("timer routine: time is $TF\n");

     # delete from my sql cache table entries older than 2H

     sql_query("delete from kamailio_cache where last_updated<$TS-3600");

 }

@@ -75,8 +75,8 @@ Carsten Bock

               5.7. rtpproxy_stream2uac(prompt_name, count),

               5.8. rtpproxy_stream2uas(prompt_name, count)

               5.9. rtpproxy_stop_stream2uac(),

-              5.10. start_recording()

-              5.11. rtpproxy_stop_stream2uas(prompt_name, count)

+              5.10. rtpproxy_stop_stream2uas()

+              5.11. start_recording()

         6. Exported Pseudo Variables

@@ -109,10 +109,11 @@ Carsten Bock

    1.16. rtpproxy_destroy usage

    1.17. rtpproxy_manage usage

    1.18. rtpproxy_stream2xxx usage

-   1.19. start_recording usage

-   1.20. $rtpstat-Usage

-   1.21. nh_enable_rtpp usage

-   1.22. nh_show_rtpp usage

+   1.19. rtpproxy_stop_stream2uas usage

+   1.20. start_recording usage

+   1.21. $rtpstat-Usage

+   1.22. nh_enable_rtpp usage

+   1.23. nh_show_rtpp usage

 Chapter 1. Admin Guide

@@ -150,8 +151,8 @@ Chapter 1. Admin Guide

         5.7. rtpproxy_stream2uac(prompt_name, count),

         5.8. rtpproxy_stream2uas(prompt_name, count)

         5.9. rtpproxy_stop_stream2uac(),

-        5.10. start_recording()

-        5.11. rtpproxy_stop_stream2uas(prompt_name, count)

+        5.10. rtpproxy_stop_stream2uas()

+        5.11. start_recording()

    6. Exported Pseudo Variables

@@ -415,8 +416,8 @@ xlog("L_INFO", "Chose rtpp instance $var(RTP_INSTANCE)\n");

    5.7. rtpproxy_stream2uac(prompt_name, count),

    5.8. rtpproxy_stream2uas(prompt_name, count)

    5.9. rtpproxy_stop_stream2uac(),

-   5.10. start_recording()

-   5.11. rtpproxy_stop_stream2uas(prompt_name, count)

+   5.10. rtpproxy_stop_stream2uas()

+   5.11. start_recording()

 5.1.  set_rtp_proxy_set(setid)

@@ -714,7 +715,23 @@ rtpproxy_manage();

    These functions can be used from REQUEST_ROUTE, ONREPLY_ROUTE.

-5.10.  start_recording()

+5.10.  rtpproxy_stop_stream2uas()

+

+   See function rtpproxy_stop_stream2uac().

+

+   Example 1.19. rtpproxy_stop_stream2uas usage

+...

+    if (is_method("INVITE")) {

+        rtpproxy_offer();

+        if (is_audio_on_hold()) {

+            rtpproxy_stream2uas("/var/rtpproxy/prompts/music_on_hold", "-1");

+        } else {

+            rtpproxy_stop_stream2uas();

+        };

+    };

+...

+

+5.11.  start_recording()

    This function will send a signal to the RTP-Proxy to record the RTP

    stream on the RTP-Proxy. This function is only supported by Sippy

@@ -722,15 +739,11 @@ rtpproxy_manage();

    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.

-   Example 1.19. start_recording usage

+   Example 1.20. start_recording usage

 ...

 start_recording();

 ...

-5.11.  rtpproxy_stop_stream2uas(prompt_name, count)

-

-   See function rtpproxy_stop_stream2uac(prompt_name, count).

-

 6. Exported Pseudo Variables

    6.1. $rtpstat

@@ -742,7 +755,7 @@ start_recording();

    packet-counters. The statistics must be retrieved before the session is

    deleted (before unforce_rtpproxy()).

-   Example 1.20. $rtpstat-Usage

+   Example 1.21. $rtpstat-Usage

 ...

     append_hf("X-RTP-Statistics: $rtpstat\r\n");

 ...

@@ -765,7 +778,7 @@ start_recording();

    NOTE: if a rtpproxy is defined multiple times (in the same or different

    sets), all of its instances will be enabled/disabled.

-   Example 1.21.  nh_enable_rtpp usage

+   Example 1.22.  nh_enable_rtpp usage

 ...

 $ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0

 ...

@@ -777,7 +790,7 @@ $ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0

    No parameter.

-   Example 1.22.  nh_show_rtpp usage

+   Example 1.23.  nh_show_rtpp usage

 ...

 $ kamctl fifo nh_show_rtpp

 ...

@@ -290,6 +290,26 @@ if(sdp_with_active_media("video"))

    Remove the streams that match on 'm=type ...' line. The parameter can

    be static string or variable holding the media type.

+   Note: If this is executed on a request, the callee should reply without

+   the Media too. However, RFC 3264 mandates, that the reply should

+   contain the exact same number of "m=" lines as the request.

+

+

+     6 Generating the Answer

+

+     [...]

+

+     For each "m=" line in the offer, there MUST be a corresponding "m="

+     line in the answer. The answer MUST contain exactly the same number of

+     "m=" lines as the offer. This allows for streams to be matched up based

+     on their order. This implies that if the offer contained zero "m="

+     lines, the answer MUST contain zero "m=" lines.

+

+                                                                  --RFC 3264

+

+   So this may not work with all Endpoints, especially if they follow RFC

+   3264 precisely (e.g. JSSIP).

+

    This function can be used from ANY_ROUTE.

    Example 1.8. sdp_remove_media usage

@@ -1,4 +1,4 @@

-The SL Module - Statless request handling

+The SL Module - Stateless request handling

 Bogdan Iancu

@@ -1571,7 +1571,7 @@ modparam("tm", "dns_reuse_rcv_socket", 1)

 4.46. xavp_contact (string)

    The name of XAVP storing the attributes per contact. This must be the

-   same as the usrloc parameter xavp_contacts.

+   same as the usrloc parameter xavp_contact.

    Default value is “NULL”.

@@ -836,7 +836,7 @@ modparam("usrloc", "timer_procs", 4)

    Example 1.34. Set xavp_contact parameter

 ...

-modparam("usrloc", "xavp_contact", "ulattrs")

+modparam("tm|usrloc", "xavp_contact", "ulattrs")

 ...

 3.35. db_ops_ruid (int)