From bc74d54ac2f5611303b592b9aae687d40c8999ef Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Thu, 17 Sep 2015 18:53:55 +0200 Subject: [PATCH] utils: regenerated the readme file --- modules/utils/README | 100 +++++++++++++++++++++++++------------------ 1 file changed, 58 insertions(+), 42 deletions(-) diff --git a/modules/utils/README b/modules/utils/README index 26ebe2d0be1..ed2a87262cc 100644 --- a/modules/utils/README +++ b/modules/utils/README @@ -8,9 +8,9 @@ Carsten Bock ng-voice GmbH - Copyright © 2008-2009 Juha Heinanen + Copyright 2008-2009 Juha Heinanen - Copyright © 2013-2015 Carsten Bock, ng-voice GmbH + Copyright 2013-2015 Carsten Bock, ng-voice GmbH __________________________________________________________________ Table of Contents @@ -26,9 +26,10 @@ Carsten Bock 3. Parameters 3.1. http_query_timeout (int) - 3.2. forward_active (int) - 3.3. pres_db_url (string) - 3.4. xcap_table (string) + 3.2. http_response_trim (int) + 3.3. forward_active (int) + 3.4. pres_db_url (string) + 3.5. xcap_table (string) 4. Functions @@ -47,15 +48,16 @@ Carsten Bock List of Examples 1.1. Set http_query_timeout parameter - 1.2. Set forward_active parameter - 1.3. Set pres_db_url parameter - 1.4. Set xcap_table parameter - 1.5. http_query() usage - 1.6. xcap_auth_status() usage - 1.7. forward_list usage - 1.8. forward_switch usage - 1.9. forward_filter usage - 1.10. forward_proxy usage + 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 Chapter 1. Admin Guide @@ -70,9 +72,10 @@ Chapter 1. Admin Guide 3. Parameters 3.1. http_query_timeout (int) - 3.2. forward_active (int) - 3.3. pres_db_url (string) - 3.4. xcap_table (string) + 3.2. http_response_trim (int) + 3.3. forward_active (int) + 3.4. pres_db_url (string) + 3.5. xcap_table (string) 4. Functions @@ -104,7 +107,7 @@ Chapter 1. Admin Guide deactivated. Function xcap_auth_status can be used to check from presence server - database, if watcher is authorized to subscribe event “presence” of + database, if watcher is authorized to subscribe event "presence" of presentity. 2. Dependencies @@ -126,9 +129,10 @@ Chapter 1. Admin Guide 3. Parameters 3.1. http_query_timeout (int) - 3.2. forward_active (int) - 3.3. pres_db_url (string) - 3.4. xcap_table (string) + 3.2. http_response_trim (int) + 3.3. forward_active (int) + 3.4. pres_db_url (string) + 3.5. xcap_table (string) 3.1. http_query_timeout (int) @@ -143,37 +147,49 @@ Chapter 1. Admin Guide modparam("utils", "http_query_timeout", 2) ... -3.2. forward_active (int) +3.2. 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 +... +modparam("utils", "http_response_trim", 1) +... + +3.3. forward_active (int) Defines if the forwarding callback should be installed. - Default value is “0” - disabled. + Default value is "0" - disabled. - Example 1.2. Set forward_active parameter + Example 1.3. Set forward_active parameter ... modparam("utils", "forward_active", 1) ... -3.3. pres_db_url (string) +3.4. 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.3. Set pres_db_url parameter + Example 1.4. Set pres_db_url parameter ... modparam("utils", "pres_db_url", "mysql://foo:secret@localhost/pres") ... -3.4. xcap_table (string) +3.5. 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”. + Default value is "xcap". - Example 1.4. Set xcap_table parameter + Example 1.5. Set xcap_table parameter ... modparam("utils", "xcap_table", "pres_xcap") ... @@ -183,21 +199,21 @@ modparam("utils", "xcap_table", "pres_xcap") 4.1. http_query(url, [post-data], [header-data], result) 4.2. xcap_auth_status(watcher_uri, presentity_uri) -4.1. http_query(url, [post-data], [header-data], result) +4.1. http_query(url, [post-data], [header-data], result) - Sends HTTP GET or POST request according to URL given in “url” + Sends HTTP GET or POST request according to URL given in "url" parameter, which is a string that may contain pseudo variables. - If you want to make a POST-Request, you have to define the “post”-data, + If you want to make a POST-Request, you have to define the "post"-data, that should be submitted in that request as the second parameter. If this parameter is empty, it is not set. If you want to add additional headers to the request, you have to - define the “header”-data, that should be submitted in that request as + define the "header"-data, that should be submitted in that request as the third parameter. If this parameter is empty, it is not set. If HTTP server returns a class 2xx, 3xx or 4xx reply, the first line of - the reply's body (if any) is stored in “result” parameter, which must + the reply's body (if any) is stored in "result" parameter, which must be a writable pseudo variable. Function returns reply code of HTTP reply or -1 if something went @@ -206,7 +222,7 @@ modparam("utils", "xcap_table", "pres_xcap") This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, FAILURE_ROUTE, and BRANCH_ROUTE. - Example 1.5. http_query() usage + Example 1.6. http_query() usage ... # GET-Request http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(fu{s @@ -235,10 +251,10 @@ switch ($retcode) { } ... -4.2. xcap_auth_status(watcher_uri, presentity_uri) +4.2. xcap_auth_status(watcher_uri, presentity_uri) Function checks in the presence server database if a watcher is - authorized to subscribe to event “presence” of presentity. Sphere + authorized to subscribe to event "presence" of presentity. Sphere checking is not included. Both watcher_uri and presentity_uri are pseudo variables. The function @@ -249,7 +265,7 @@ switch ($retcode) { Function can be used from REQUEST_ROUTE. - Example 1.6. xcap_auth_status() usage + Example 1.7. xcap_auth_status() usage ... if (method=="MESSAGE") { xcap_auth_status("$fu", $ru"); @@ -274,7 +290,7 @@ if (method=="MESSAGE") { No parameters. - Example 1.7. forward_list usage + Example 1.8. forward_list usage ... kamctl fifo forward_list id switch filter proxy @@ -287,7 +303,7 @@ id switch filter proxy The syntax of this configuration string is described in 1.6. (switch_setting_list). - Example 1.8. forward_switch usage + Example 1.9. forward_switch usage ... kamctl fifo forward_switch 0=on ... @@ -306,7 +322,7 @@ kamctl fifo forward_switch 0=on The syntax of this configuration string is described in 1.6. (filter_setting_list). - Example 1.9. forward_filter usage + Example 1.10. forward_filter usage ... kamctl fifo forward_filter 0=REGISTER:INVITE ... @@ -319,7 +335,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.10. forward_proxy usage + Example 1.11. forward_proxy usage ... kamctl fifo forward_proxy 0=host-c.domain-c:5060 ...