Răsfoiți Sursa

modules: readme files regenerated - modules ... [skip ci]

Kamailio Dev 4 ani în urmă
părinte
comite
fa2e51786d

+ 6 - 2
src/modules/pv/README

@@ -186,8 +186,8 @@ Chapter 1. Admin Guide
 
 
 3.1. shvset (string)
 3.1. shvset (string)
 
 
-   Set the value of a shared variable ($shv(name)). The parameter can be
-   set many times.
+   Set the initial value of a shared variable ($shv(name)). The parameter
+   can be set many times.
 
 
    The value of the parameter has the format: _name_ '=' _type_ ':'
    The value of the parameter has the format: _name_ '=' _type_ ':'
    _value_
    _value_
@@ -197,6 +197,10 @@ Chapter 1. Admin Guide
           + “s”: string value
           + “s”: string value
      * _value_: value to be set
      * _value_: value to be set
 
 
+   Note: this is special useful for usage with KEMI scripts, the $shv(...)
+   variables must be defined during Kamailio initialization in order to
+   become available in all worker processes.
+
    Default value is “NULL”.
    Default value is “NULL”.
 
 
    Example 1.1. shvset parameter usage
    Example 1.1. shvset parameter usage

+ 66 - 47
src/modules/registrar/README

@@ -84,15 +84,16 @@ Bogdan-Andre Iancu
 
 
               4.1. save(domain, [, flags [, uri]])
               4.1. save(domain, [, flags [, uri]])
               4.2. lookup(domain [, uri])
               4.2. lookup(domain [, uri])
-              4.3. lookup_branches(domain)
-              4.4. registered(domain [, uri [, match_option [,
+              4.3. lookup_to_dset(domain [, uri])
+              4.4. lookup_branches(domain)
+              4.5. registered(domain [, uri [, match_option [,
                       match_action]]])
                       match_action]]])
 
 
-              4.5. add_sock_hdr(hdr_name)
-              4.6. unregister(domain, uri[, ruid])
-              4.7. reg_fetch_contacts(domain, uri, profile)
-              4.8. reg_free_contacts(profile)
-              4.9. reg_send_reply()
+              4.6. add_sock_hdr(hdr_name)
+              4.7. unregister(domain, uri[, ruid])
+              4.8. reg_fetch_contacts(domain, uri, profile)
+              4.9. reg_free_contacts(profile)
+              4.10. reg_send_reply()
 
 
         5. Event Routes
         5. Event Routes
 
 
@@ -149,15 +150,16 @@ Bogdan-Andre Iancu
    1.33. Set use_expired_contacts parameter
    1.33. Set use_expired_contacts parameter
    1.34. save usage
    1.34. save usage
    1.35. lookup usage
    1.35. lookup usage
-   1.36. lookup_branches usage
-   1.37. registered usage
-   1.38. add_sock_hdr usage
-   1.39. unregister usage
-   1.40. reg_fetch_contacts usage
-   1.41. reg_free_contacts usage
-   1.42. reg_send_reply usage
-   1.43. event_route[usrloc:contact-expired] usage
-   1.44. $ulc(name) usage
+   1.36. lookup_to_dset usage
+   1.37. lookup_branches usage
+   1.38. registered usage
+   1.39. add_sock_hdr usage
+   1.40. unregister usage
+   1.41. reg_fetch_contacts usage
+   1.42. reg_free_contacts usage
+   1.43. reg_send_reply usage
+   1.44. event_route[usrloc:contact-expired] usage
+   1.45. $ulc(name) usage
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
 
 
@@ -214,13 +216,14 @@ Chapter 1. Admin Guide
 
 
         4.1. save(domain, [, flags [, uri]])
         4.1. save(domain, [, flags [, uri]])
         4.2. lookup(domain [, uri])
         4.2. lookup(domain [, uri])
-        4.3. lookup_branches(domain)
-        4.4. registered(domain [, uri [, match_option [, match_action]]])
-        4.5. add_sock_hdr(hdr_name)
-        4.6. unregister(domain, uri[, ruid])
-        4.7. reg_fetch_contacts(domain, uri, profile)
-        4.8. reg_free_contacts(profile)
-        4.9. reg_send_reply()
+        4.3. lookup_to_dset(domain [, uri])
+        4.4. lookup_branches(domain)
+        4.5. registered(domain [, uri [, match_option [, match_action]]])
+        4.6. add_sock_hdr(hdr_name)
+        4.7. unregister(domain, uri[, ruid])
+        4.8. reg_fetch_contacts(domain, uri, profile)
+        4.9. reg_free_contacts(profile)
+        4.10. reg_send_reply()
 
 
    5. Event Routes
    5. Event Routes
 
 
@@ -945,13 +948,14 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
 
 
    4.1. save(domain, [, flags [, uri]])
    4.1. save(domain, [, flags [, uri]])
    4.2. lookup(domain [, uri])
    4.2. lookup(domain [, uri])
-   4.3. lookup_branches(domain)
-   4.4. registered(domain [, uri [, match_option [, match_action]]])
-   4.5. add_sock_hdr(hdr_name)
-   4.6. unregister(domain, uri[, ruid])
-   4.7. reg_fetch_contacts(domain, uri, profile)
-   4.8. reg_free_contacts(profile)
-   4.9. reg_send_reply()
+   4.3. lookup_to_dset(domain [, uri])
+   4.4. lookup_branches(domain)
+   4.5. registered(domain [, uri [, match_option [, match_action]]])
+   4.6. add_sock_hdr(hdr_name)
+   4.7. unregister(domain, uri[, ruid])
+   4.8. reg_fetch_contacts(domain, uri, profile)
+   4.9. reg_free_contacts(profile)
+   4.10. reg_send_reply()
 
 
 4.1.  save(domain, [, flags [, uri]])
 4.1.  save(domain, [, flags [, uri]])
 
 
@@ -1032,7 +1036,8 @@ save("location", "0x00", "sip:[email protected]");
    Example 1.35. lookup usage
    Example 1.35. lookup usage
 ...
 ...
 lookup("location");
 lookup("location");
-switch ($retcode) {
+                        switch ($retcode) {:1
+
     case -1:
     case -1:
     case -3:
     case -3:
         sl_send_reply("404", "Not Found");
         sl_send_reply("404", "Not Found");
@@ -1043,7 +1048,21 @@ switch ($retcode) {
 };
 };
 ...
 ...
 
 
-4.3.  lookup_branches(domain)
+4.3.  lookup_to_dset(domain [, uri])
+
+   Similar to lookup(...), but push the location contacts to destination
+   set, without changing the R-URI (first branch not changed, it creates
+   additional branches). For the meaning of the parameters and the return
+   codes, see the documentation for lookup(...) function.
+
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
+
+   Example 1.36. lookup_to_dset usage
+...
+lookup_to_dset("location");
+...
+
+4.4.  lookup_branches(domain)
 
 
    The function performs lookup(domain) on r-uri and additional branches
    The function performs lookup(domain) on r-uri and additional branches
    (only branches that have no other attributes set than uri).
    (only branches that have no other attributes set than uri).
@@ -1055,12 +1074,12 @@ switch ($retcode) {
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
 
-   Example 1.36. lookup_branches usage
+   Example 1.37. lookup_branches usage
 ...
 ...
 lookup_branches("location");
 lookup_branches("location");
 ...
 ...
 
 
-4.4.  registered(domain [, uri [, match_option [, match_action]]])
+4.5.  registered(domain [, uri [, match_option [, match_action]]])
 
 
    The function returns true if the AOR in the URI is registered, false
    The function returns true if the AOR in the URI is registered, false
    otherwise. The function does not modify the message being process, it
    otherwise. The function does not modify the message being process, it
@@ -1087,7 +1106,7 @@ lookup_branches("location");
 
 
    This function can be used from ANY_ROUTE.
    This function can be used from ANY_ROUTE.
 
 
-   Example 1.37. registered usage
+   Example 1.38. registered usage
 ...
 ...
 if (registered("location")) {
 if (registered("location")) {
         sl_send_reply("100", "Trying");
         sl_send_reply("100", "Trying");
@@ -1101,7 +1120,7 @@ if (registered("location","$rz:$Au", 2)) {
 };
 };
 ...
 ...
 
 
-4.5.  add_sock_hdr(hdr_name)
+4.6.  add_sock_hdr(hdr_name)
 
 
    Adds a new header to the current REGISTER request with “hdr_name” which
    Adds a new header to the current REGISTER request with “hdr_name” which
    contains the description of the received socket (proto:ip:port)
    contains the description of the received socket (proto:ip:port)
@@ -1114,12 +1133,12 @@ if (registered("location","$rz:$Au", 2)) {
 
 
    This function can be used from REQUEST_ROUTE.
    This function can be used from REQUEST_ROUTE.
 
 
-   Example 1.38. add_sock_hdr usage
+   Example 1.39. add_sock_hdr usage
 ...
 ...
 add_sock_hdr("Sock-Info");
 add_sock_hdr("Sock-Info");
 ...
 ...
 
 
-4.6.  unregister(domain, uri[, ruid])
+4.7.  unregister(domain, uri[, ruid])
 
 
    The function removes contacts associated with 'uri' from the location
    The function removes contacts associated with 'uri' from the location
    database. If 'ruid' is provided a specific contact is removed, if
    database. If 'ruid' is provided a specific contact is removed, if
@@ -1144,7 +1163,7 @@ add_sock_hdr("Sock-Info");
      * -2 - Error in unregistering user
      * -2 - Error in unregistering user
      * -3 - Contacts for AOR not found
      * -3 - Contacts for AOR not found
 
 
-   Example 1.39. unregister usage
+   Example 1.40. unregister usage
 ...
 ...
 unregister("location", "$ru");
 unregister("location", "$ru");
 unregister("location", "sip:[email protected]");
 unregister("location", "sip:[email protected]");
@@ -1152,7 +1171,7 @@ unregister("location", "$ru", "$ulc(caller=>ruid)");
 unregister("location", "", "$ruid");
 unregister("location", "", "$ruid");
 ...
 ...
 
 
-4.7.  reg_fetch_contacts(domain, uri, profile)
+4.8.  reg_fetch_contacts(domain, uri, profile)
 
 
    The function fetches the contacts for 'uri' from table 'domain' to
    The function fetches the contacts for 'uri' from table 'domain' to
    pseudo-variable $ulc(profile).
    pseudo-variable $ulc(profile).
@@ -1168,13 +1187,13 @@ unregister("location", "", "$ruid");
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
 
-   Example 1.40. reg_fetch_contacts usage
+   Example 1.41. reg_fetch_contacts usage
 ...
 ...
 reg_fetch_contacts("location", "$ru", "callee");
 reg_fetch_contacts("location", "$ru", "callee");
 reg_fetch_contacts("location", "sip:[email protected]", "caller");
 reg_fetch_contacts("location", "sip:[email protected]", "caller");
 ...
 ...
 
 
-4.8.  reg_free_contacts(profile)
+4.9.  reg_free_contacts(profile)
 
 
    The function frees the contacts from pseudo-variable $ulc(profile).
    The function frees the contacts from pseudo-variable $ulc(profile).
    Should be called to release the content of a profile. Anyhow, fetching
    Should be called to release the content of a profile. Anyhow, fetching
@@ -1187,12 +1206,12 @@ reg_fetch_contacts("location", "sip:[email protected]", "caller");
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
 
-   Example 1.41. reg_free_contacts usage
+   Example 1.42. reg_free_contacts usage
 ...
 ...
 reg_free_contacts("callee");
 reg_free_contacts("callee");
 ...
 ...
 
 
-4.9.  reg_send_reply()
+4.10.  reg_send_reply()
 
 
    The function sends the SIP reply that is normally sent by save(...),
    The function sends the SIP reply that is normally sent by save(...),
    but that was skipped due to flag 0x2. It must be used after save(...,
    but that was skipped due to flag 0x2. It must be used after save(...,
@@ -1201,7 +1220,7 @@ reg_free_contacts("callee");
 
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
 
-   Example 1.42. reg_send_reply usage
+   Example 1.43. reg_send_reply usage
 ...
 ...
 save("location", "0x2");
 save("location", "0x2");
 ...
 ...
@@ -1217,7 +1236,7 @@ reg_send_reply();
    Executed when a contact in location table has expired. The variable
    Executed when a contact in location table has expired. The variable
    $ulc(exp=>...) is filled with the attributes of the expired contact.
    $ulc(exp=>...) is filled with the attributes of the expired contact.
 
 
-   Example 1.43. event_route[usrloc:contact-expired] usage
+   Example 1.44. event_route[usrloc:contact-expired] usage
 ...
 ...
 event_route[usrloc:contact-expired] {
 event_route[usrloc:contact-expired] {
     xlog("expired contact for $ulc(exp=>aor)\n");
     xlog("expired contact for $ulc(exp=>aor)\n");
@@ -1291,7 +1310,7 @@ event_route[usrloc:contact-expired] {
    The pseudo-variable accepts positive index value to access a specific
    The pseudo-variable accepts positive index value to access a specific
    contact record.
    contact record.
 
 
-   Example 1.44. $ulc(name) usage
+   Example 1.45. $ulc(name) usage
 ...
 ...
 if(reg_fetch_contacts("location", "$fu", "caller"))
 if(reg_fetch_contacts("location", "$fu", "caller"))
 {
 {

+ 2 - 2
src/modules/rtpengine/README

@@ -232,7 +232,7 @@ Richard Fuchs
    1.70. Set mos_average_roundtrip_B_pv parameter
    1.70. Set mos_average_roundtrip_B_pv parameter
    1.71. Set mos_average_samples_B_pv parameter
    1.71. Set mos_average_samples_B_pv parameter
    1.72. Set control_cmd_tos parameter
    1.72. Set control_cmd_tos parameter
-   1.73. Set control_cmd_tos parameter
+   1.73. Set hash_algo parameter
    1.74. set_rtpengine_set usage
    1.74. set_rtpengine_set usage
    1.75. rtpengine_offer usage
    1.75. rtpengine_offer usage
    1.76. rtpengine_answer usage
    1.76. rtpengine_answer usage
@@ -1811,7 +1811,7 @@ modparam("rtpengine", "control_cmd_tos", 144)
 
 
    The values not falling into the range “0-1” are ignored.
    The values not falling into the range “0-1” are ignored.
 
 
-   Example 1.73. Set control_cmd_tos parameter
+   Example 1.73. Set hash_algo parameter
 ...
 ...
 ### use SHA1 instead of legacy algorithm
 ### use SHA1 instead of legacy algorithm
 modparam("rtpengine", "hash_algo", 1)
 modparam("rtpengine", "hash_algo", 1)

+ 3 - 0
src/modules/textops/README

@@ -331,6 +331,9 @@ From: medabeda
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * re - Regular expression.
      * re - Regular expression.
 
 
+   Note: it performs Posix regex matching and the 're' parameter is
+   compiled with the flags REG_EXTENDED|REG_ICASE|REG_NEWLINE.
+
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE, BRANCH_ROUTE.
    FAILURE_ROUTE, BRANCH_ROUTE.
 
 

+ 111 - 64
src/modules/uac/README

@@ -63,13 +63,14 @@ Ramona-Elena Modroiu
               4.5. uac_replace_to(uri)
               4.5. uac_replace_to(uri)
               4.6. uac_restore_to()
               4.6. uac_restore_to()
               4.7. uac_auth([mode])
               4.7. uac_auth([mode])
-              4.8. uac_req_send()
-              4.9. uac_reg_lookup(uuid, dst)
-              4.10. uac_reg_status(uuid)
-              4.11. uac_reg_request_to(user, mode)
-              4.12. uac_reg_enable(attr, val)
-              4.13. uac_reg_disable(attr, val)
-              4.14. uac_reg_refresh(luuid)
+              4.8. uac_auth_mode(vmode)
+              4.9. uac_req_send()
+              4.10. uac_reg_lookup(uuid, dst)
+              4.11. uac_reg_status(uuid)
+              4.12. uac_reg_request_to(user, mode)
+              4.13. uac_reg_enable(attr, val)
+              4.14. uac_reg_disable(attr, val)
+              4.15. uac_reg_refresh(luuid)
 
 
         5. Pseudo Variables
         5. Pseudo Variables
         6. Event Routes
         6. Event Routes
@@ -122,24 +123,25 @@ Ramona-Elena Modroiu
    1.27. uac_replace_to usage
    1.27. uac_replace_to usage
    1.28. uac_restore_to usage
    1.28. uac_restore_to usage
    1.29. uac_auth usage
    1.29. uac_auth usage
-   1.30. uac_req_send usage
-   1.31. uac_reg_lookup usage
-   1.32. uac_reg_status usage
-   1.33. uac_reg_request_to usage
-   1.34. uac_reg_enable usage
-   1.35. uac_reg_disable usage
-   1.36. uac_reg_refresh usage
-   1.37. event_route[uac:reply] usage
-   1.38. uac.reg_dump usage
-   1.39. uac.reg_info usage
-   1.40. uac.reg_enable usage
-   1.41. uac.reg_disable usage
-   1.42. uac.reg_reload usage
-   1.43. uac.reg_refresh usage
-   1.44. uac.reg_active usage
-   1.45. uac.reg_add usage
-   1.46. uac.reg_remove usage
-   1.47. lookup remote registrations usage
+   1.30. uac_auth_mode usage
+   1.31. uac_req_send usage
+   1.32. uac_reg_lookup usage
+   1.33. uac_reg_status usage
+   1.34. uac_reg_request_to usage
+   1.35. uac_reg_enable usage
+   1.36. uac_reg_disable usage
+   1.37. uac_reg_refresh usage
+   1.38. event_route[uac:reply] usage
+   1.39. uac.reg_dump usage
+   1.40. uac.reg_info usage
+   1.41. uac.reg_enable usage
+   1.42. uac.reg_disable usage
+   1.43. uac.reg_reload usage
+   1.44. uac.reg_refresh usage
+   1.45. uac.reg_active usage
+   1.46. uac.reg_add usage
+   1.47. uac.reg_remove usage
+   1.48. lookup remote registrations usage
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
 
 
@@ -185,13 +187,14 @@ Chapter 1. Admin Guide
         4.5. uac_replace_to(uri)
         4.5. uac_replace_to(uri)
         4.6. uac_restore_to()
         4.6. uac_restore_to()
         4.7. uac_auth([mode])
         4.7. uac_auth([mode])
-        4.8. uac_req_send()
-        4.9. uac_reg_lookup(uuid, dst)
-        4.10. uac_reg_status(uuid)
-        4.11. uac_reg_request_to(user, mode)
-        4.12. uac_reg_enable(attr, val)
-        4.13. uac_reg_disable(attr, val)
-        4.14. uac_reg_refresh(luuid)
+        4.8. uac_auth_mode(vmode)
+        4.9. uac_req_send()
+        4.10. uac_reg_lookup(uuid, dst)
+        4.11. uac_reg_status(uuid)
+        4.12. uac_reg_request_to(user, mode)
+        4.13. uac_reg_enable(attr, val)
+        4.14. uac_reg_disable(attr, val)
+        4.15. uac_reg_refresh(luuid)
 
 
    5. Pseudo Variables
    5. Pseudo Variables
    6. Event Routes
    6. Event Routes
@@ -625,13 +628,14 @@ end
    4.5. uac_replace_to(uri)
    4.5. uac_replace_to(uri)
    4.6. uac_restore_to()
    4.6. uac_restore_to()
    4.7. uac_auth([mode])
    4.7. uac_auth([mode])
-   4.8. uac_req_send()
-   4.9. uac_reg_lookup(uuid, dst)
-   4.10. uac_reg_status(uuid)
-   4.11. uac_reg_request_to(user, mode)
-   4.12. uac_reg_enable(attr, val)
-   4.13. uac_reg_disable(attr, val)
-   4.14. uac_reg_refresh(luuid)
+   4.8. uac_auth_mode(vmode)
+   4.9. uac_req_send()
+   4.10. uac_reg_lookup(uuid, dst)
+   4.11. uac_reg_status(uuid)
+   4.12. uac_reg_request_to(user, mode)
+   4.13. uac_reg_enable(attr, val)
+   4.14. uac_reg_disable(attr, val)
+   4.15. uac_reg_refresh(luuid)
 
 
 4.1.  uac_replace_from(display,uri)
 4.1.  uac_replace_from(display,uri)
 
 
@@ -814,7 +818,50 @@ failure_route[TRUNKAUTH] {
 }
 }
 ...
 ...
 
 
-4.8.  uac_req_send()
+4.8.  uac_auth_mode(vmode)
+
+   This function can be called only from failure route and will build the
+   authentication response header and insert it into the request without
+   sending anything.
+
+   If mode is set to 1, then the password has to be provided in HA1
+   format. The parameter can be a static integer or a variable holding an
+   integer value.
+
+   This function can be used from FAILURE_ROUTE.
+
+   Example 1.30. uac_auth_mode usage
+...
+modparam("uac","auth_username_avp","$avp(auser)")
+modparam("uac","auth_password_avp","$avp(apass)")
+modparam("uac","auth_realm_avp","$avp(arealm)")
+
+request_route {
+   ...
+   if(is_method("INVITE")) {
+      t_on_failure("TRUNKAUTH");
+   }
+   ...
+}
+
+failure_route[TRUNKAUTH] {
+
+    if (t_is_canceled()) {
+        exit;
+    }
+    if(t_check_status("401|407")) {
+        $avp(auser) = "test";
+        $avp(apass) = "test";
+        # $avp(apass) = "36d0a02793542b4961e8348347236dbf";
+        if (uac_auth_mode("1")) {
+            t_relay();
+        }
+        exit;
+    }
+}
+...
+
+4.9.  uac_req_send()
 
 
    This function sends a SIP message from the configuration file. The
    This function sends a SIP message from the configuration file. The
    message is built out of $uac_req(...) pseudo-variable.
    message is built out of $uac_req(...) pseudo-variable.
@@ -822,7 +869,7 @@ failure_route[TRUNKAUTH] {
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE, ONREPLY_ROUTE, LOCAL_ROUTE.
    BRANCH_ROUTE, ONREPLY_ROUTE, LOCAL_ROUTE.
 
 
-   Example 1.30. uac_req_send usage
+   Example 1.31. uac_req_send usage
 ...
 ...
 $uac_req(method)="OPTIONS";
 $uac_req(method)="OPTIONS";
 $uac_req(ruri)="sip:kamailio.org";
 $uac_req(ruri)="sip:kamailio.org";
@@ -832,14 +879,14 @@ $uac_req(callid)=$(mb{s.md5});
 uac_req_send();
 uac_req_send();
 ...
 ...
 
 
-4.9.  uac_reg_lookup(uuid, dst)
+4.10.  uac_reg_lookup(uuid, dst)
 
 
    This function sets the PV dst to SIP URI that correspond to uuid in uac
    This function sets the PV dst to SIP URI that correspond to uuid in uac
    registrations table. uuid and dst must be pseudo-variables.
    registrations table. uuid and dst must be pseudo-variables.
 
 
    This function can be used from ANY_ROUTE.
    This function can be used from ANY_ROUTE.
 
 
-   Example 1.31. uac_reg_lookup usage
+   Example 1.32. uac_reg_lookup usage
 ...
 ...
 
 
 if(uac_reg_lookup("$rU", "$ru"))
 if(uac_reg_lookup("$rU", "$ru"))
@@ -848,7 +895,7 @@ if(uac_reg_lookup("$rU", "$ru"))
 }
 }
 ...
 ...
 
 
-4.10.  uac_reg_status(uuid)
+4.11.  uac_reg_status(uuid)
 
 
    This function returns the current registration status for the uuid.
    This function returns the current registration status for the uuid.
 
 
@@ -863,12 +910,12 @@ if(uac_reg_lookup("$rU", "$ru"))
 
 
    This function can be used from ANY_ROUTE.
    This function can be used from ANY_ROUTE.
 
 
-   Example 1.32. uac_reg_status usage
+   Example 1.33. uac_reg_status usage
 ...
 ...
 $var(status) = uac_reg_status("$rU");
 $var(status) = uac_reg_status("$rU");
 ...
 ...
 
 
-4.11.  uac_reg_request_to(user, mode)
+4.12.  uac_reg_request_to(user, mode)
 
 
    This function can be used to send an authenticated request to a remote
    This function can be used to send an authenticated request to a remote
    user in the uac registrations table. It sets the request-uri, dst-uri
    user in the uac registrations table. It sets the request-uri, dst-uri
@@ -888,7 +935,7 @@ $var(status) = uac_reg_status("$rU");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE.
    BRANCH_ROUTE.
 
 
-   Example 1.33. uac_reg_request_to usage
+   Example 1.34. uac_reg_request_to usage
 ...
 ...
 
 
 if(uac_reg_request_to("$fU", 0))
 if(uac_reg_request_to("$fU", 0))
@@ -907,7 +954,7 @@ failure_route[REMOTE_AUTH] {
 }
 }
 ...
 ...
 
 
-4.12.  uac_reg_enable(attr, val)
+4.13.  uac_reg_enable(attr, val)
 
 
    Enable a remote registration record based on a filter specified by
    Enable a remote registration record based on a filter specified by
    attribute and value. The attribute can be: l_uuid, l_username,
    attribute and value. The attribute can be: l_uuid, l_username,
@@ -916,12 +963,12 @@ failure_route[REMOTE_AUTH] {
 
 
    The SIP processing is done on the next timer routine.
    The SIP processing is done on the next timer routine.
 
 
-   Example 1.34. uac_reg_enable usage
+   Example 1.35. uac_reg_enable usage
 ...
 ...
    uac_reg_enable("l_uuid", "account123");
    uac_reg_enable("l_uuid", "account123");
 ...
 ...
 
 
-4.13.  uac_reg_disable(attr, val)
+4.14.  uac_reg_disable(attr, val)
 
 
    Disable a remote registration record based on a filter specified by
    Disable a remote registration record based on a filter specified by
    attribute and value. The attribute can be: l_uuid, l_username,
    attribute and value. The attribute can be: l_uuid, l_username,
@@ -930,18 +977,18 @@ failure_route[REMOTE_AUTH] {
 
 
    The SIP processing is done on the next timer routine.
    The SIP processing is done on the next timer routine.
 
 
-   Example 1.35. uac_reg_disable usage
+   Example 1.36. uac_reg_disable usage
 ...
 ...
    uac_reg_disable("l_uuid", "account123");
    uac_reg_disable("l_uuid", "account123");
 ...
 ...
 
 
-4.14.  uac_reg_refresh(luuid)
+4.15.  uac_reg_refresh(luuid)
 
 
    Refresh the uac remote registration record based on local uuid. If the
    Refresh the uac remote registration record based on local uuid. If the
    record was already loaded, new values are taken from database,
    record was already loaded, new values are taken from database,
    otherwise a new record is created.
    otherwise a new record is created.
 
 
-   Example 1.36. uac_reg_refresh usage
+   Example 1.37. uac_reg_refresh usage
 ...
 ...
    uac_reg_refresh("account123");
    uac_reg_refresh("account123");
 ...
 ...
@@ -965,7 +1012,7 @@ failure_route[REMOTE_AUTH] {
    then the event_route is executed twice, first for 401/407 and second
    then the event_route is executed twice, first for 401/407 and second
    for final reply of the transaction.
    for final reply of the transaction.
 
 
-   Example 1.37. event_route[uac:reply] usage
+   Example 1.38. event_route[uac:reply] usage
 ...
 ...
 $uac_req(method)="OPTIONS";
 $uac_req(method)="OPTIONS";
 $uac_req(ruri)="sip:kamailio.org";
 $uac_req(ruri)="sip:kamailio.org";
@@ -1004,7 +1051,7 @@ event_route[uac:reply] {
 
 
    Dump the content of remote registration table from memory.
    Dump the content of remote registration table from memory.
 
 
-   Example 1.38. uac.reg_dump usage
+   Example 1.39. uac.reg_dump usage
 ...
 ...
    kamcmd uac.reg_dump
    kamcmd uac.reg_dump
 ...
 ...
@@ -1025,7 +1072,7 @@ event_route[uac:reply] {
      * 16 (2^4) - registration initialized (after loading from database,
      * 16 (2^4) - registration initialized (after loading from database,
        the registration process was initialized)
        the registration process was initialized)
 
 
-   Example 1.39. uac.reg_info usage
+   Example 1.40. uac.reg_info usage
 ...
 ...
    kamcmd uac.reg_info l_uuid account123
    kamcmd uac.reg_info l_uuid account123
    kamcmd uac.reg_info l_uuid s:12345678
    kamcmd uac.reg_info l_uuid s:12345678
@@ -1039,7 +1086,7 @@ event_route[uac:reply] {
    matched against the value of the attribute in the remote registration
    matched against the value of the attribute in the remote registration
    record.
    record.
 
 
-   Example 1.40. uac.reg_enable usage
+   Example 1.41. uac.reg_enable usage
 ...
 ...
    kamcmd uac.reg_enable l_uuid account123
    kamcmd uac.reg_enable l_uuid account123
    kamcmd uac.reg_enable l_uuid s:12345678
    kamcmd uac.reg_enable l_uuid s:12345678
@@ -1053,7 +1100,7 @@ event_route[uac:reply] {
    matched against the value of the attribute in the remote registration
    matched against the value of the attribute in the remote registration
    record.
    record.
 
 
-   Example 1.41. uac.reg_disable usage
+   Example 1.42. uac.reg_disable usage
 ...
 ...
    kamcmd uac.reg_disable l_uuid account123
    kamcmd uac.reg_disable l_uuid account123
    kamcmd uac.reg_disable l_uuid s:12345678
    kamcmd uac.reg_disable l_uuid s:12345678
@@ -1066,7 +1113,7 @@ event_route[uac:reply] {
    150 seconds between reloads -- see the reg_gc_interval parameter for
    150 seconds between reloads -- see the reg_gc_interval parameter for
    more details.
    more details.
 
 
-   Example 1.42. uac.reg_reload usage
+   Example 1.43. uac.reg_reload usage
 ...
 ...
    kamcmd uac.reg_reload
    kamcmd uac.reg_reload
 ...
 ...
@@ -1077,7 +1124,7 @@ event_route[uac:reply] {
    the record exists in memory, it will be replaced with the new values
    the record exists in memory, it will be replaced with the new values
    loaded from database.
    loaded from database.
 
 
-   Example 1.43. uac.reg_refresh usage
+   Example 1.44. uac.reg_refresh usage
 ...
 ...
    kamcmd uac.reg_refresh account123
    kamcmd uac.reg_refresh account123
    kamcmd uac.reg_refresh s:12345678
    kamcmd uac.reg_refresh s:12345678
@@ -1089,7 +1136,7 @@ event_route[uac:reply] {
    1 enables remote registrations for all records and 0 disables doing
    1 enables remote registrations for all records and 0 disables doing
    them.
    them.
 
 
-   Example 1.44. uac.reg_active usage
+   Example 1.45. uac.reg_active usage
 ...
 ...
    kamctl rpc uac.reg_active 0
    kamctl rpc uac.reg_active 0
    kamctl rpc uac.reg_active 1
    kamctl rpc uac.reg_active 1
@@ -1118,7 +1165,7 @@ event_route[uac:reply] {
 
 
    Use a dot (.) if no value should be set for auth_password or auth_ha1.
    Use a dot (.) if no value should be set for auth_password or auth_ha1.
 
 
-   Example 1.45. uac.reg_add usage
+   Example 1.46. uac.reg_add usage
 ...
 ...
    kamcmd uac.reg_add ...
    kamcmd uac.reg_add ...
 ...
 ...
@@ -1127,7 +1174,7 @@ event_route[uac:reply] {
 
 
    Remove a UAC remote registration record by l_uuid.
    Remove a UAC remote registration record by l_uuid.
 
 
-   Example 1.46. uac.reg_remove usage
+   Example 1.47. uac.reg_remove usage
 ...
 ...
    kamcmd uac.reg_remove my_l_uuid
    kamcmd uac.reg_remove my_l_uuid
 ...
 ...
@@ -1178,7 +1225,7 @@ event_route[uac:reply] {
    if the call is coming from a remote SIP provider and can change the
    if the call is coming from a remote SIP provider and can change the
    R-URI to local username@domain. Afterwards you can run location lookup.
    R-URI to local username@domain. Afterwards you can run location lookup.
 
 
-   Example 1.47. lookup remote registrations usage
+   Example 1.48. lookup remote registrations usage
 ...
 ...
     if(uac_reg_lookup("$rU", "$ru")) {
     if(uac_reg_lookup("$rU", "$ru")) {
         xlog("request from a remote SIP provider [$ou => $ru]\n");
         xlog("request from a remote SIP provider [$ou => $ru]\n");