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

src/modules/registrar/README

@@ -78,6 +78,7 @@ Bogdan-Andre Iancu
               3.31. contact_max_size (integer)
               3.32. event_callback (str)
               3.33. lookup_filter_mode (int)
+              3.34. use_expired_contacts (int)
 
         4. Functions
 
@@ -145,17 +146,18 @@ Bogdan-Andre Iancu
    1.30. Set contact_max_size parameter
    1.31. Set event_callback parameter
    1.32. Set xavp_cfg parameter
-   1.33. save usage
-   1.34. lookup usage
-   1.35. lookup_branches usage
-   1.36. registered usage
-   1.37. add_sock_hdr usage
-   1.38. unregister usage
-   1.39. reg_fetch_contacts usage
-   1.40. reg_free_contacts usage
-   1.41. reg_send_reply usage
-   1.42. event_route[usrloc:contact-expired] usage
-   1.43. $ulc(name) usage
+   1.33. Set use_expired_contacts parameter
+   1.34. save 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
 
 Chapter 1. Admin Guide
 
@@ -206,6 +208,7 @@ Chapter 1. Admin Guide
         3.31. contact_max_size (integer)
         3.32. event_callback (str)
         3.33. lookup_filter_mode (int)
+        3.34. use_expired_contacts (int)
 
    4. Functions
 
@@ -334,6 +337,7 @@ Chapter 1. Admin Guide
    3.31. contact_max_size (integer)
    3.32. event_callback (str)
    3.33. lookup_filter_mode (int)
+   3.34. use_expired_contacts (int)
 
 3.1. default_expires (integer)
 
@@ -920,6 +924,22 @@ request_route {
 }
 ...
 
+3.34. use_expired_contacts (int)
+
+   Allow/Disallow the usage of the expired contacts.
+     * 0 Disallow the usage of the expired contacts.
+     * 1 Allow the usage of the expired contacts.
+
+   Default value is 0 (Disallow).
+
+   Example 1.33. Set use_expired_contacts parameter
+...
+modparam("registrar", "use_expired_contacts", 1)
+...
+
+kamcmd cfg.set_now_int registrar use_expired_contacts 1
+kamcmd cfg.set_now_int registrar use_expired_contacts 0
+
 4. Functions
 
    4.1. save(domain, [, flags [, uri]])
@@ -973,7 +993,7 @@ request_route {
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE and
    REPLY_ROUTE.
 
-   Example 1.33. save usage
+   Example 1.34. save usage
 ...
 save("location");
 save("location", "0x01");
@@ -1006,7 +1026,7 @@ save("location", "0x00", "sip:test@kamailio.org");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.34. lookup usage
+   Example 1.35. lookup usage
 ...
 lookup("location");
 switch ($retcode) {
@@ -1032,7 +1052,7 @@ switch ($retcode) {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.35. lookup_branches usage
+   Example 1.36. lookup_branches usage
 ...
 lookup_branches("location");
 ...
@@ -1064,7 +1084,7 @@ lookup_branches("location");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.36. registered usage
+   Example 1.37. registered usage
 ...
 if (registered("location")) {
         sl_send_reply("100", "Trying");
@@ -1091,7 +1111,7 @@ if (registered("location","$rz:$Au", 2)) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.37. add_sock_hdr usage
+   Example 1.38. add_sock_hdr usage
 ...
 add_sock_hdr("Sock-Info");
 ...
@@ -1121,7 +1141,7 @@ add_sock_hdr("Sock-Info");
      * -2 - Error in unregistering user
      * -3 - Contacts for AOR not found
 
-   Example 1.38. unregister usage
+   Example 1.39. unregister usage
 ...
 unregister("location", "$ru");
 unregister("location", "sip:user@kamailio.org");
@@ -1145,7 +1165,7 @@ unregister("location", "", "$ruid");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.39. reg_fetch_contacts usage
+   Example 1.40. reg_fetch_contacts usage
 ...
 reg_fetch_contacts("location", "$ru", "callee");
 reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
@@ -1164,7 +1184,7 @@ reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.40. reg_free_contacts usage
+   Example 1.41. reg_free_contacts usage
 ...
 reg_free_contacts("callee");
 ...
@@ -1178,7 +1198,7 @@ reg_free_contacts("callee");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.41. reg_send_reply usage
+   Example 1.42. reg_send_reply usage
 ...
 save("location", "0x2");
 ...
@@ -1194,7 +1214,7 @@ reg_send_reply();
    Executed when a contact in location table has expired. The variable
    $ulc(exp=>...) is filled with the attributes of the expired contact.
 
-   Example 1.42. event_route[usrloc:contact-expired] usage
+   Example 1.43. event_route[usrloc:contact-expired] usage
 ...
 event_route[usrloc:contact-expired] {
     xlog("expired contact for $ulc(exp=>aor)\n");
@@ -1268,7 +1288,7 @@ event_route[usrloc:contact-expired] {
    The pseudo-variable accepts positive index value to access a specific
    contact record.
 
-   Example 1.43. $ulc(name) usage
+   Example 1.44. $ulc(name) usage
 ...
 if(reg_fetch_contacts("location", "$fu", "caller"))
 {