modules: readme files regenerated - registrar ...

modules/registrar/README

@@ -75,6 +75,7 @@ Bogdan-Andre Iancu
               3.26. outbound_mode (integer)
               3.27. regid_mode (integer)
               3.28. flow_timer (integer)
+              3.29. contact_max_size (integer)
 
         4. Functions
 
@@ -136,16 +137,17 @@ Bogdan-Andre Iancu
    1.25. Set outbound_mode parameter
    1.26. Set regid_mode parameter
    1.27. Set flow_timer parameter
-   1.28. save usage
-   1.29. lookup usage
-   1.30. lookup_branches usage
-   1.31. registered usage
-   1.32. add_sock_hdr usage
-   1.33. unregister usage
-   1.34. reg_fetch_contacts usage
-   1.35. reg_free_contacts usage
-   1.36. event_route[usrloc:contact-expired] usage
-   1.37. $ulc(name) usage
+   1.28. Set contact_max_size parameter
+   1.29. save usage
+   1.30. lookup usage
+   1.31. lookup_branches usage
+   1.32. registered usage
+   1.33. add_sock_hdr usage
+   1.34. unregister usage
+   1.35. reg_fetch_contacts usage
+   1.36. reg_free_contacts usage
+   1.37. event_route[usrloc:contact-expired] usage
+   1.38. $ulc(name) usage
 
 Chapter 1. Admin Guide
 
@@ -191,6 +193,7 @@ Chapter 1. Admin Guide
         3.26. outbound_mode (integer)
         3.27. regid_mode (integer)
         3.28. flow_timer (integer)
+        3.29. contact_max_size (integer)
 
    4. Functions
 
@@ -313,6 +316,7 @@ Chapter 1. Admin Guide
    3.26. outbound_mode (integer)
    3.27. regid_mode (integer)
    3.28. flow_timer (integer)
+   3.29. contact_max_size (integer)
 
 3.1. default_expires (integer)
 
@@ -790,6 +794,26 @@ modparam("registrar", "regid_mode", 1)
 modparam("registrar", "flow_timer", 25)
 ...
 
+3.29. contact_max_size (integer)
+
+   Max size of URIs in “Contact:” header.
+
+   The size of URIs in “Contact:” headers are checked to be lower or equal
+   to this value. A warning is logged and a 400 Bad Request is sent in
+   response to REGISTER requests with contact URIs that are longer than
+   this value.
+
+   If a database is used then you must make sure that your database model
+   supports strings of the configured size in the column “contact” of the
+   table specified in “save()” function.
+
+   Default value is 255.
+
+   Example 1.28. Set contact_max_size parameter
+...
+modparam("registrar", "contact_max_size", 500)
+...
+
 4. Functions
 
    4.1. save(domain, [, flags [, uri]])
@@ -841,7 +865,7 @@ modparam("registrar", "flow_timer", 25)
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE and
    REPLY_ROUTE.
 
-   Example 1.28. save usage
+   Example 1.29. save usage
 ...
 save("location");
 save("location", "0x01");
@@ -874,7 +898,7 @@ save("location", "0x00", "sip:[email protected]");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.29. lookup usage
+   Example 1.30. lookup usage
 ...
 lookup("location");
 switch ($retcode) {
@@ -900,7 +924,7 @@ switch ($retcode) {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.30. lookup_branches usage
+   Example 1.31. lookup_branches usage
 ...
 lookup_branches("location");
 ...
@@ -932,7 +956,7 @@ lookup_branches("location");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.31. registered usage
+   Example 1.32. registered usage
 ...
 if (registered("location")) {
         sl_send_reply("100", "Trying");
@@ -958,7 +982,7 @@ if (registered("location","$rz:$Au", 2)) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.32. add_sock_hdr usage
+   Example 1.33. add_sock_hdr usage
 ...
 add_sock_hdr("Sock-Info");
 ...
@@ -988,7 +1012,7 @@ add_sock_hdr("Sock-Info");
      * -2 - Error in unregistering user
      * -3 - Contacts for AOR not found
 
-   Example 1.33. unregister usage
+   Example 1.34. unregister usage
 ...
 unregister("location", "$ru");
 unregister("location", "sip:[email protected]");
@@ -1012,7 +1036,7 @@ unregister("location", "", "$ruid");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.34. reg_fetch_contacts usage
+   Example 1.35. reg_fetch_contacts usage
 ...
 reg_fetch_contacts("location", "$ru", "callee");
 reg_fetch_contacts("location", "sip:[email protected]", "caller");
@@ -1031,7 +1055,7 @@ reg_fetch_contacts("location", "sip:[email protected]", "caller");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.35. reg_free_contacts usage
+   Example 1.36. reg_free_contacts usage
 ...
 reg_free_contacts("callee");
 ...
@@ -1045,7 +1069,7 @@ reg_free_contacts("callee");
    Executed when a contact in location table has expired. The variable
    $ulc(exp=>...) is filled with the attributes of the expired contact.
 
-   Example 1.36. event_route[usrloc:contact-expired] usage
+   Example 1.37. event_route[usrloc:contact-expired] usage
 ...
 event_route[usrloc:contact-expired] {
     xlog("expired contact for $ulc(exp=>aor)\n");
@@ -1118,7 +1142,7 @@ event_route[usrloc:contact-expired] {
    The pseudo-variable accepts positive index value to access a specific
    contact record.
 
-   Example 1.37. $ulc(name) usage
+   Example 1.38. $ulc(name) usage
 ...
 if(reg_fetch_contacts("location", "$fu", "caller"))
 {