[sr-dev] git:master: utils: Minor documentation changes
Olle E. Johansson
oej at edvina.net
Thu Nov 29 21:16:15 CET 2012
Module: sip-router
Branch: master
Commit: 1ab39cf866600ce155db3d5454981167d001d285
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=1ab39cf866600ce155db3d5454981167d001d285
Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: Thu Nov 29 21:15:53 2012 +0100
utils: Minor documentation changes
---
modules/utils/README | 39 +++++++++++++++++++-----------------
modules/utils/doc/utils_admin.xml | 27 +++++++++++++------------
2 files changed, 35 insertions(+), 31 deletions(-)
diff --git a/modules/utils/README b/modules/utils/README
index 4c967c5..a4ff648 100644
--- a/modules/utils/README
+++ b/modules/utils/README
@@ -4,7 +4,7 @@ Juha Heinanen
TutPro Inc.
- Copyright © 2008-2009 Juha Heinanen
+ Copyright © 2008-2009 Juha Heinanen
__________________________________________________________________
Table of Contents
@@ -98,7 +98,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 +126,11 @@ Chapter 1. Admin Guide
3.1. http_query_timeout (int)
- Defines in seconds how long Kamailio waits response from HTTP server.
+ Defines in seconds how long Kamailio waits for response from HTTP
+ server.
- Default value is null, i.e., xcap_auth_status function is disabled.
+ Default value is zero, i.e., that the http_query_timeout function is
+ disabled.
Example 1.1. Set http_query_timeout parameter
...
@@ -139,7 +141,7 @@ modparam("utils", "http_query_timeout", 2)
Defines if the forwarding callback should be installed.
- Default value is “0â€.
+ Default value is "0" - disabled.
Example 1.2. Set forward_active parameter
...
@@ -148,8 +150,8 @@ modparam("utils", "http_query_timeout", 2)
3.3. pres_db_url (string)
- Defines presence server database URL. If not given, xcap_auth_status
- function is disabled.
+ Defines presence server database URL. If not given, the
+ xcap_auth_status function is disabled.
There is no default value.
@@ -160,9 +162,10 @@ modparam("utils", "pres_db_url", "mysql://foo:secret@localhost/pres")
3.4. xcap_table (string)
- Defines name of xcap table in presence server database.
+ 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
...
@@ -176,12 +179,12 @@ modparam("utils", "xcap_table", "pres_xcap")
4.1. http_query(url, result)
- Sends HTTP GET request according to URL given in “url†parameter, which
+ Sends HTTP GET request according to URL given in "url" parameter, which
is a string that may contain pseudo variables.
- If HTTP server returns a class 2xx or 3xx reply, first line of reply's
- body (if any) is stored in “result†parameter, which must be a writable
- pseudo variable.
+ If HTTP server returns a class 2xx or 3xx reply, the first line of 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
wrong.
@@ -201,12 +204,12 @@ switch ($retcode) {
4.2. xcap_auth_status(watcher_uri, presentity_uri)
- Function checks from presence server database if watcher is authorized
- to subscribe event “presence†of presentity. Sphere checking is not
- included.
+ Function checks in the presence server database if a watcher is
+ authorized to subscribe to event "presence" of presentity. Sphere
+ checking is not included.
- Both watcher_uri and presentity_uri are pseudo variables. Function
- returns ACTIVE_STATUS, if subscription is allowed and PENDING_STATUS,
+ Both watcher_uri and presentity_uri are pseudo variables. The function
+ returns ACTIVE_STATUS, if a subscription is allowed and PENDING_STATUS,
TERMINATED_STATUS, or WAITING_STATUS otherwise. See
presence/subscribe.h for the corresponding integer codes. In case of
error, function returns -1.
diff --git a/modules/utils/doc/utils_admin.xml b/modules/utils/doc/utils_admin.xml
index 28e611a..12e91d2 100644
--- a/modules/utils/doc/utils_admin.xml
+++ b/modules/utils/doc/utils_admin.xml
@@ -75,13 +75,13 @@
<section>
<title><varname>http_query_timeout</varname> (int)</title>
<para>
- Defines in seconds how long &kamailio; waits response
+ Defines in seconds how long &kamailio; waits for response
from HTTP server.
</para>
<para>
<emphasis>
- Default value is null, i.e.,
- xcap_auth_status function is disabled.
+ Default value is zero, i.e.,
+ that the http_query_timeout function is disabled.
</emphasis>
</para>
<example>
@@ -100,7 +100,7 @@ modparam("utils", "http_query_timeout", 2)
</para>
<para>
<emphasis>
- Default value is <quote>0</quote>.
+ Default value is <quote>0</quote> - disabled.
</emphasis>
</para>
<example>
@@ -115,8 +115,8 @@ modparam("utils", "http_query_timeout", 2)
<section>
<title><varname>pres_db_url</varname> (string)</title>
<para>
- Defines presence server database URL. If not
- given, xcap_auth_status function is disabled.
+ Defines presence server database URL. If not
+ given, the xcap_auth_status function is disabled.
</para>
<para>
<emphasis>
@@ -135,7 +135,8 @@ modparam("utils", "pres_db_url", "mysql://foo:secret@localhost/pres")
<section>
<title><varname>xcap_table</varname> (string)</title>
<para>
- Defines name of xcap table in presence server database.
+ Defines the name of the xcap table in the presence server database.
+ See the xcap_server module documentation for more information.
</para>
<para>
<emphasis>
@@ -166,7 +167,7 @@ modparam("utils", "xcap_table", "pres_xcap")
</para>
<para>
If HTTP server returns a class 2xx or 3xx reply,
- first line of reply's body (if any) is
+ the first line of the reply's body (if any) is
stored in <quote>result</quote> parameter,
which must be a writable pseudo variable.
</para>
@@ -176,7 +177,7 @@ modparam("utils", "xcap_table", "pres_xcap")
</para>
<para>
This function can be used from REQUEST_ROUTE,
- ONREPLY_ROUTE, FAILURE_ROUTE, and BRANCH_ROUTE.
+ ONREPLY_ROUTE, FAILURE_ROUTE, and BRANCH_ROUTE.
</para>
<example>
<title><function>http_query()</function> usage</title>
@@ -196,15 +197,15 @@ switch ($retcode) {
<function moreinfo="none">xcap_auth_status(watcher_uri, presentity_uri)</function>
</title>
<para>
- Function checks from presence server database if
- watcher is authorized to subscribe event
+ Function checks in the presence server database if
+ a watcher is authorized to subscribe to event
<quote>presence</quote> of presentity. Sphere
checking is not included.
</para>
<para>
Both watcher_uri and presentity_uri are
- pseudo variables. Function returns
- ACTIVE_STATUS, if subscription is
+ pseudo variables. The function returns
+ ACTIVE_STATUS, if a subscription is
allowed and PENDING_STATUS, TERMINATED_STATUS,
or WAITING_STATUS otherwise. See
presence/subscribe.h for the corresponding integer
More information about the sr-dev
mailing list