utils: readme updated for http_response_mode

modules/utils/README

@@ -26,10 +26,11 @@ Carsten Bock
         3. Parameters
 
               3.1. http_query_timeout (int)
-              3.2. http_response_trim (int)
-              3.3. forward_active (int)
-              3.4. pres_db_url (string)
-              3.5. xcap_table (string)
+              3.2. http_response_mode (int)
+              3.3. http_response_trim (int)
+              3.4. forward_active (int)
+              3.5. pres_db_url (string)
+              3.6. xcap_table (string)
 
         4. Functions
 
@@ -48,16 +49,17 @@ Carsten Bock
    List of Examples
 
    1.1. Set http_query_timeout parameter
-   1.2. Set http_response_trim parameter
-   1.3. Set forward_active parameter
-   1.4. Set pres_db_url parameter
-   1.5. Set xcap_table parameter
-   1.6. http_query() usage
-   1.7. xcap_auth_status() usage
-   1.8. forward_list usage
-   1.9. forward_switch usage
-   1.10. forward_filter usage
-   1.11. forward_proxy usage
+   1.2. Set http_response_mode parameter
+   1.3. Set http_response_trim parameter
+   1.4. Set forward_active parameter
+   1.5. Set pres_db_url parameter
+   1.6. Set xcap_table parameter
+   1.7. http_query() usage
+   1.8. xcap_auth_status() usage
+   1.9. forward_list usage
+   1.10. forward_switch usage
+   1.11. forward_filter usage
+   1.12. forward_proxy usage
 
 Chapter 1. Admin Guide
 
@@ -72,10 +74,11 @@ Chapter 1. Admin Guide
    3. Parameters
 
         3.1. http_query_timeout (int)
-        3.2. http_response_trim (int)
-        3.3. forward_active (int)
-        3.4. pres_db_url (string)
-        3.5. xcap_table (string)
+        3.2. http_response_mode (int)
+        3.3. http_response_trim (int)
+        3.4. forward_active (int)
+        3.5. pres_db_url (string)
+        3.6. xcap_table (string)
 
    4. Functions
 
@@ -129,10 +132,11 @@ Chapter 1. Admin Guide
 3. Parameters
 
    3.1. http_query_timeout (int)
-   3.2. http_response_trim (int)
-   3.3. forward_active (int)
-   3.4. pres_db_url (string)
-   3.5. xcap_table (string)
+   3.2. http_response_mode (int)
+   3.3. http_response_trim (int)
+   3.4. forward_active (int)
+   3.5. pres_db_url (string)
+   3.6. xcap_table (string)
 
 3.1. http_query_timeout (int)
 
@@ -147,49 +151,61 @@ Chapter 1. Admin Guide
 modparam("utils", "http_query_timeout", 2)
 ...
 
-3.2. http_response_trim (int)
+3.2. http_response_mode (int)
+
+   Control what part of the HTTP reponse is returned: only first line (for
+   value 0), or all response (for value 1).
+
+   Default value is 0 (return only the first line).
+
+   Example 1.2. Set http_response_mode parameter
+...
+modparam("utils", "http_response_mode", 1)
+...
+
+3.3. http_response_trim (int)
 
    Control if white space, tab and end of line characters should be
    trimmed from leading and trailing parts of HTTP response.
 
    Default value is 0 (don't trim).
 
-   Example 1.2. Set http_response_trim parameter
+   Example 1.3. Set http_response_trim parameter
 ...
 modparam("utils", "http_response_trim", 1)
 ...
 
-3.3. forward_active (int)
+3.4. forward_active (int)
 
    Defines if the forwarding callback should be installed.
 
    Default value is "0" - disabled.
 
-   Example 1.3. Set forward_active parameter
+   Example 1.4. Set forward_active parameter
                                         ...
                                         modparam("utils", "forward_active", 1)
                                         ...
 
-3.4. pres_db_url (string)
+3.5. pres_db_url (string)
 
    Defines presence server database URL. If not given, the
    xcap_auth_status function is disabled.
 
    There is no default value.
 
-   Example 1.4. Set pres_db_url parameter
+   Example 1.5. Set pres_db_url parameter
 ...
 modparam("utils", "pres_db_url", "mysql://foo:secret@localhost/pres")
 ...
 
-3.5. xcap_table (string)
+3.6. xcap_table (string)
 
    Defines the name of the xcap table in the presence server database. See
    the xcap_server module documentation for more information.
 
    Default value is "xcap".
 
-   Example 1.5. Set xcap_table parameter
+   Example 1.6. Set xcap_table parameter
 ...
 modparam("utils", "xcap_table", "pres_xcap")
 ...
@@ -222,7 +238,7 @@ modparam("utils", "xcap_table", "pres_xcap")
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE, and BRANCH_ROUTE.
 
-   Example 1.6. http_query() usage
+   Example 1.7. http_query() usage
 ...
 # GET-Request
 http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(fu{s
@@ -265,7 +281,7 @@ switch ($retcode) {
 
    Function can be used from REQUEST_ROUTE.
 
-   Example 1.7. xcap_auth_status() usage
+   Example 1.8. xcap_auth_status() usage
 ...
 if (method=="MESSAGE") {
     xcap_auth_status("$fu", $ru");
@@ -290,7 +306,7 @@ if (method=="MESSAGE") {
 
    No parameters.
 
-   Example 1.8. forward_list usage
+   Example 1.9. forward_list usage
 ...
 kamctl fifo forward_list
 id switch                         filter proxy
@@ -303,7 +319,7 @@ id switch                         filter proxy
    The syntax of this configuration string is described in 1.6.
    (switch_setting_list).
 
-   Example 1.9. forward_switch usage
+   Example 1.10. forward_switch usage
 ...
 kamctl fifo forward_switch 0=on
 ...
@@ -322,7 +338,7 @@ kamctl fifo forward_switch 0=on
    The syntax of this configuration string is described in 1.6.
    (filter_setting_list).
 
-   Example 1.10. forward_filter usage
+   Example 1.11. forward_filter usage
 ...
 kamctl fifo forward_filter 0=REGISTER:INVITE
 ...
@@ -335,7 +351,7 @@ kamctl fifo forward_filter 0=REGISTER:INVITE
    switch). The syntax of this configuration string is described in 1.6.
    (proxy_setting_list).
 
-   Example 1.11. forward_proxy usage
+   Example 1.12. forward_proxy usage
 ...
 kamctl fifo forward_proxy 0=host-c.domain-c:5060
 ...