modules_k/registrar: Removed tcp_persistent_flag module parameter.

- Commented out tcp_persistent_flag module parameter, because sr_3.0 tm
  does not support it.
- Removed the flags also from module README.

modules_k/registrar/README

@@ -40,22 +40,21 @@ Bogdan-Andre Iancu
               3.2. min_expires (integer)
               3.3. max_expires (integer)
               3.4. default_q (integer)
-              3.5. tcp_persistent_flag (integer)
-              3.6. realm_prefix (string)
-              3.7. append_branches (integer)
-              3.8. aor_avp (str)
-              3.9. case_sensitive (integer)
-              3.10. received_avp (str)
-              3.11. received_param (string)
-              3.12. max_contacts (integer)
-              3.13. retry_after (integer)
-              3.14. sock_flag (integer)
-              3.15. sock_hdr_name (string)
-              3.16. method_filtering (integer)
-              3.17. use_path (integer)
-              3.18. path_mode (integer)
-              3.19. path_use_received (integer)
-              3.20. reg_callid_avp (string)
+              3.5. realm_prefix (string)
+              3.6. append_branches (integer)
+              3.7. aor_avp (str)
+              3.8. case_sensitive (integer)
+              3.9. received_avp (str)
+              3.10. received_param (string)
+              3.11. max_contacts (integer)
+              3.12. retry_after (integer)
+              3.13. sock_flag (integer)
+              3.14. sock_hdr_name (string)
+              3.15. method_filtering (integer)
+              3.16. use_path (integer)
+              3.17. path_mode (integer)
+              3.18. path_use_received (integer)
+              3.19. reg_callid_avp (string)
 
         4. Exported Functions
 
@@ -88,31 +87,30 @@ Bogdan-Andre Iancu
    1.2. Set min_expires parameter
    1.3. Set max_expires parameter
    1.4. Set default_q parameter
-   1.5. Set tcp_persistent_flag parameter
-   1.6. Set realm_prefix parameter
-   1.7. Set append_branches parameter
-   1.8. Set aor_avp parameter
-   1.9. Set case_sensitive parameter
-   1.10. Set received_avp parameter
-   1.11. Set received_param parameter
-   1.12. Set max_contacts parameter
-   1.13. Set retry_after parameter
-   1.14. Set sock_flag parameter
-   1.15. Set sock_hdr_namer parameter
-   1.16. Set method_filtering parameter
-   1.17. Set use_path parameter
-   1.18. Set path_mode parameter
-   1.19. Set path_use_received parameter
-   1.20. Set reg_callid_avp parameter
+   1.5. Set realm_prefix parameter
+   1.6. Set append_branches parameter
+   1.7. Set aor_avp parameter
+   1.8. Set case_sensitive parameter
+   1.9. Set received_avp parameter
+   1.10. Set received_param parameter
+   1.11. Set max_contacts parameter
+   1.12. Set retry_after parameter
+   1.13. Set sock_flag parameter
+   1.14. Set sock_hdr_namer parameter
+   1.15. Set method_filtering parameter
+   1.16. Set use_path parameter
+   1.17. Set path_mode parameter
+   1.18. Set path_use_received parameter
+   1.19. Set reg_callid_avp parameter
+   1.20. save usage
    1.21. save usage
-   1.22. save usage
-   1.23. lookup usage
-   1.24. registered usage
-   1.25. add_sock_hdr usage
+   1.22. lookup usage
+   1.23. registered usage
+   1.24. add_sock_hdr usage
+   1.25. registered usage
    1.26. registered usage
    1.27. registered usage
-   1.28. registered usage
-   1.29. $sht(name) usage
+   1.28. $sht(name) usage
 
 Chapter 1. Admin Guide
 
@@ -133,22 +131,21 @@ Chapter 1. Admin Guide
         3.2. min_expires (integer)
         3.3. max_expires (integer)
         3.4. default_q (integer)
-        3.5. tcp_persistent_flag (integer)
-        3.6. realm_prefix (string)
-        3.7. append_branches (integer)
-        3.8. aor_avp (str)
-        3.9. case_sensitive (integer)
-        3.10. received_avp (str)
-        3.11. received_param (string)
-        3.12. max_contacts (integer)
-        3.13. retry_after (integer)
-        3.14. sock_flag (integer)
-        3.15. sock_hdr_name (string)
-        3.16. method_filtering (integer)
-        3.17. use_path (integer)
-        3.18. path_mode (integer)
-        3.19. path_use_received (integer)
-        3.20. reg_callid_avp (string)
+        3.5. realm_prefix (string)
+        3.6. append_branches (integer)
+        3.7. aor_avp (str)
+        3.8. case_sensitive (integer)
+        3.9. received_avp (str)
+        3.10. received_param (string)
+        3.11. max_contacts (integer)
+        3.12. retry_after (integer)
+        3.13. sock_flag (integer)
+        3.14. sock_hdr_name (string)
+        3.15. method_filtering (integer)
+        3.16. use_path (integer)
+        3.17. path_mode (integer)
+        3.18. path_use_received (integer)
+        3.19. reg_callid_avp (string)
 
    4. Exported Functions
 
@@ -230,22 +227,21 @@ Chapter 1. Admin Guide
    3.2. min_expires (integer)
    3.3. max_expires (integer)
    3.4. default_q (integer)
-   3.5. tcp_persistent_flag (integer)
-   3.6. realm_prefix (string)
-   3.7. append_branches (integer)
-   3.8. aor_avp (str)
-   3.9. case_sensitive (integer)
-   3.10. received_avp (str)
-   3.11. received_param (string)
-   3.12. max_contacts (integer)
-   3.13. retry_after (integer)
-   3.14. sock_flag (integer)
-   3.15. sock_hdr_name (string)
-   3.16. method_filtering (integer)
-   3.17. use_path (integer)
-   3.18. path_mode (integer)
-   3.19. path_use_received (integer)
-   3.20. reg_callid_avp (string)
+   3.5. realm_prefix (string)
+   3.6. append_branches (integer)
+   3.7. aor_avp (str)
+   3.8. case_sensitive (integer)
+   3.9. received_avp (str)
+   3.10. received_param (string)
+   3.11. max_contacts (integer)
+   3.12. retry_after (integer)
+   3.13. sock_flag (integer)
+   3.14. sock_hdr_name (string)
+   3.15. method_filtering (integer)
+   3.16. use_path (integer)
+   3.17. path_mode (integer)
+   3.18. path_use_received (integer)
+   3.19. reg_callid_avp (string)
 
 3.1. default_expires (integer)
 
@@ -301,23 +297,7 @@ modparam("registrar", "max_expires", 120)
 modparam("registrar", "default_q", 1000)
 ...
 
-3.5. tcp_persistent_flag (integer)
-
-   The parameter specifies the message flag to be used to control the
-   module behaviour regarding TCP connections. If the flag is set for a
-   REGISTER via TCP containing a TCP contact, the module, via the "save()"
-   functions will set the lifetime of the TCP connection to the contact
-   expire value. By doing this, the TCP connection will stay on as long as
-   the contact is valid.
-
-   Default value is -1 (disabled).
-
-   Example 1.5. Set tcp_persistent_flag parameter
-...
-modparam("registrar", "tcp_persistent_flag", 7)
-...
-
-3.6. realm_prefix (string)
+3.5. realm_prefix (string)
 
    Prefix to be automatically strip from realm. As an alternative to SRV
    records (not all SIP clients support SRV lookup), a subdomain of the
@@ -328,12 +308,12 @@ modparam("registrar", "tcp_persistent_flag", 7)
 
    Default value is NULL (none).
 
-   Example 1.6. Set realm_prefix parameter
+   Example 1.5. Set realm_prefix parameter
 ...
 modparam("registrar", "realm_prefix", "sip.")
 ...
 
-3.7. append_branches (integer)
+3.6. append_branches (integer)
 
    The parameter controls how lookup function processes multiple contacts.
    If there are multiple contacts for the given username in usrloc and
@@ -345,12 +325,12 @@ modparam("registrar", "realm_prefix", "sip.")
 
    Default value is 1.
 
-   Example 1.7. Set append_branches parameter
+   Example 1.6. Set append_branches parameter
 ...
 modparam("registrar", "append_branches", 0)
 ...
 
-3.8. aor_avp (str)
+3.7. aor_avp (str)
 
    If set, the module will try first to get the AOR from this AVP instead
    of fetching it form the processed request.
@@ -360,24 +340,24 @@ modparam("registrar", "append_branches", 0)
 
    Default value is "NULL" (disabled).
 
-   Example 1.8. Set aor_avp parameter
+   Example 1.7. Set aor_avp parameter
 ...
 modparam("registrar", "aor_avp", "$avp(i:3223)")
 ...
 
-3.9. case_sensitive (integer)
+3.8. case_sensitive (integer)
 
    If set to 1 then AOR comparison will be case sensitive, if set to 0
    then AOR comparison will be case insensitive--This is recommended.
 
    Default value is 0.
 
-   Example 1.9. Set case_sensitive parameter
+   Example 1.8. Set case_sensitive parameter
 ...
 modparam("registrar", "case_sensitive", 1)
 ...
 
-3.10. received_avp (str)
+3.9. received_avp (str)
 
    Registrar will store the value of the AVP configured by this parameter
    in the received column in the user location database. It will leave the
@@ -392,24 +372,24 @@ Note
 
    Default value is "NULL" (disabled).
 
-   Example 1.10. Set received_avp parameter
+   Example 1.9. Set received_avp parameter
 ...
 modparam("registrar", "received_avp", "$avp(s:rcv)")
 ...
 
-3.11. received_param (string)
+3.10. received_param (string)
 
    The name of the parameter that will be appended to Contacts of 200 OK
    when the received URI was set by nathelper module.
 
    Default value is "received".
 
-   Example 1.11. Set received_param parameter
+   Example 1.10. Set received_param parameter
 ...
 modparam("registrar", "received_param", "rcv")
 ...
 
-3.12. max_contacts (integer)
+3.11. max_contacts (integer)
 
    The parameter can be used to limit the number of contacts per AOR
    (Address of Record) in the user location database. Value 0 disables the
@@ -417,13 +397,13 @@ modparam("registrar", "received_param", "rcv")
 
    Default value is 0.
 
-   Example 1.12. Set max_contacts parameter
+   Example 1.11. Set max_contacts parameter
 ...
 # Allow no more than 10 contacts per AOR
 modparam("registrar", "max_contacts", 10)
 ...
 
-3.13. retry_after (integer)
+3.12. retry_after (integer)
 
    The registrar can generate 5xx reply to REGISTER in various situations.
    It can, for example, happen when the max_contacts parameter is set and
@@ -436,12 +416,12 @@ modparam("registrar", "max_contacts", 10)
 
    Default value is 0 (disabled).
 
-   Example 1.13. Set retry_after parameter
+   Example 1.12. Set retry_after parameter
 ...
 modparam("registrar", "retry_after", 30)
 ...
 
-3.14. sock_flag (integer)
+3.13. sock_flag (integer)
 
    Message flag to signal to register module to look into REGISTER request
    for a header which contains a socket description (IP:port). This socket
@@ -451,12 +431,12 @@ modparam("registrar", "retry_after", 30)
 
    Default value is -1 (no flag).
 
-   Example 1.14. Set sock_flag parameter
+   Example 1.13. Set sock_flag parameter
 ...
 modparam("registrar", "sock_flag", 18)
 ...
 
-3.15. sock_hdr_name (string)
+3.14. sock_hdr_name (string)
 
    Header which contains a socket description (proto:IP:port) to override
    the received socket info. The header will be read only if the flag
@@ -466,36 +446,36 @@ modparam("registrar", "sock_flag", 18)
 
    Default value is NULL.
 
-   Example 1.15. Set sock_hdr_namer parameter
+   Example 1.14. Set sock_hdr_namer parameter
 ...
 modparam("registrar", "sock_hdr_name", "Sock-Info")
 ...
 
-3.16. method_filtering (integer)
+3.15. method_filtering (integer)
 
    Tells if the contact filtering based on supported methods should be
    performed during lookup. It's enabled only if it has a non zero value.
 
    Default value is 0 (disabled).
 
-   Example 1.16. Set method_filtering parameter
+   Example 1.15. Set method_filtering parameter
 ...
 modparam("registrar", "method_filtering", 1)
 ...
 
-3.17. use_path (integer)
+3.16. use_path (integer)
 
    If set to 1, the Path header is handled according to the parameter
    "path_mode".
 
    Default value is 0 (disabled).
 
-   Example 1.17. Set use_path parameter
+   Example 1.16. Set use_path parameter
 ...
 modparam("registrar", "use_path", 1)
 ...
 
-3.18. path_mode (integer)
+3.17. path_mode (integer)
 
    The registrar module implements three different modes regarding the
    response to a registration which includes one or more Path headers:
@@ -513,12 +493,12 @@ modparam("registrar", "use_path", 1)
 
    Default value is 2.
 
-   Example 1.18. Set path_mode parameter
+   Example 1.17. Set path_mode parameter
 ...
 modparam("registrar", "path_mode", 0)
 ...
 
-3.19. path_use_received (integer)
+3.18. path_use_received (integer)
 
    If set to 1, the "received" parameter of the first Path URI of a
    registration is set as received-uri and the NAT branch flag is set for
@@ -528,12 +508,12 @@ modparam("registrar", "path_mode", 0)
 
    Default value is 0 (disabled).
 
-   Example 1.19. Set path_use_received parameter
+   Example 1.18. Set path_use_received parameter
 ...
 modparam("registrar", "path_use_received", 1)
 ...
 
-3.20. reg_callid_avp (string)
+3.19. reg_callid_avp (string)
 
    If reg_callid_avp is defined and populated when registered() is
    invoked, the result is TRUE only if an active registration with the
@@ -541,7 +521,7 @@ modparam("registrar", "path_use_received", 1)
 
    Default value is NULL (disabled).
 
-   Example 1.20. Set reg_callid_avp parameter
+   Example 1.19. Set reg_callid_avp parameter
 ...
 modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
 ...
@@ -579,7 +559,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
 
    This function can be used from REQUEST_ROUTE and REPLY_ROUTE.
 
-   Example 1.21. save usage
+   Example 1.20. save usage
 ...
 save("location");
 ...
@@ -606,7 +586,7 @@ save("location");
 
    This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE.
 
-   Example 1.22. save usage
+   Example 1.21. save usage
 ...
 save("location","0x01");
 ...
@@ -635,7 +615,7 @@ save("location","0x01");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.23. lookup usage
+   Example 1.22. lookup usage
 ...
 lookup("location");
 switch ($retcode) {
@@ -661,7 +641,7 @@ switch ($retcode) {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.24. registered usage
+   Example 1.23. registered usage
 ...
 if (registered("location")) {
         sl_send_reply("100", "Trying");
@@ -681,7 +661,7 @@ if (registered("location")) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.25. add_sock_hdr usage
+   Example 1.24. add_sock_hdr usage
 ...
 add_sock_hdr("Sock-Info");
 ...
@@ -699,7 +679,7 @@ add_sock_hdr("Sock-Info");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.26. registered usage
+   Example 1.25. registered usage
 ...
 unregister("location", "$ru");
 unregister("location", "sip:[email protected]");
@@ -721,7 +701,7 @@ unregister("location", "sip:[email protected]");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.27. registered usage
+   Example 1.26. registered usage
 ...
 reg_fetch_contacts("location", "$ru", "callee");
 reg_fetch_contacts("location", "sip:[email protected]", "caller");
@@ -740,7 +720,7 @@ reg_fetch_contacts("location", "sip:[email protected]", "caller");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.28. registered usage
+   Example 1.27. registered usage
 ...
 reg_free_contacts("callee");
 ...
@@ -806,7 +786,7 @@ reg_free_contacts("callee");
    The pseudo-variable accepts positive index value to access a specific
    contact record.
 
-   Example 1.29. $sht(name) usage
+   Example 1.28. $sht(name) usage
 ...
 if(reg_fetch_contacts("location", "$fu", "caller"))
 {

modules_k/registrar/doc/registrar_admin.xml

@@ -197,31 +197,6 @@ modparam("registrar", "default_q", 1000)
 		</example>
 	</section>
 
-	<section>
-		<title><varname>tcp_persistent_flag</varname> (integer)</title>
-		<para>
-		The parameter specifies the message flag to be used to control the 
-		module behaviour regarding TCP connections. If the flag is set for a 
-		REGISTER via TCP containing a TCP contact, the module, via the 
-		<quote>save()</quote> functions will set the lifetime of the TCP
-		connection to the contact expire value. By doing this, the TCP 
-		connection will stay on as long as the contact is valid.
-		</para>
-		<para>
-		<emphasis>
-			Default value is -1 (disabled).
-		</emphasis>
-		</para>
-		<example>
-		<title>Set <varname>tcp_persistent_flag</varname> parameter</title>
-		<programlisting format="linespecific">
-...
-modparam("registrar", "tcp_persistent_flag", 7)
-...
-</programlisting>
-		</example>
-	</section>
-
 	<section>
 		<title><varname>realm_prefix</varname> (string)</title>
 		<para>

modules_k/registrar/reg_mod.c

@@ -41,6 +41,8 @@
  *              contacts and default expiry time(Jeffrey Magder-SOMA Networks)
  *  2007-02-24  sip_natping_flag moved into branch flags, so migrated to 
  *              nathelper module (bogdan)
+ *  2009-12-09  Commented out tcp_persistent_flag param, because sr_3.0 tm
+ *              does not support it (Juha)
  *
  */
 
@@ -191,7 +193,7 @@ static param_export_t params[] = {
 	{"default_q",          INT_PARAM, &default_q           },
 	{"append_branches",    INT_PARAM, &append_branches     },
 	{"case_sensitive",     INT_PARAM, &case_sensitive      },
-	{"tcp_persistent_flag",INT_PARAM, &tcp_persistent_flag },
+	/*	{"tcp_persistent_flag",INT_PARAM, &tcp_persistent_flag }, */
 	{"realm_prefix",       STR_PARAM, &realm_pref          },
 	{"min_expires",        INT_PARAM, &min_expires         },
 	{"max_expires",        INT_PARAM, &max_expires         },