[sr-dev] git:3.2: presence_xml: updates to docs to refer to embedded xcap server

Module: sip-router Branch: 3.2 Commit: da0eff88c7467365e9f7300960baee5aac36f27a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=da0eff8… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Fri Apr 20 09:42:39 2012 +0200 presence_xml: updates to docs to refer to embedded xcap server (cherry picked from commit 171f560f768b43e140c24b6cc4823a92f13b2f05) --- modules_k/presence_xml/README | 29 +++++++++++---------- modules_k/presence_xml/doc/presence_xml_admin.xml | 11 ++++--- 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/modules_k/presence_xml/README b/modules_k/presence_xml/README index 84b0da2..b53cc01 100644 --- a/modules_k/presence_xml/README +++ b/modules_k/presence_xml/README @@ -21,7 +21,7 @@ Anca-Maria Vamanu 2.1. Kamailio Modules 2.2. External Libraries or Applications - 3. Exported Parameters + 3. Parameters 3.1. db_url(str) 3.2. xcap_table(str) @@ -34,7 +34,7 @@ Anca-Maria Vamanu 3.9. xcap_server (str) 3.10. passive_mode(int) - 4. Exported Functions + 4. Functions 4.1. pres_check_basic(presentity_uri, status) 4.2. pres_check_activities(presentity_uri, activity) @@ -69,7 +69,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules 2.2. External Libraries or Applications - 3. Exported Parameters + 3. Parameters 3.1. db_url(str) 3.2. xcap_table(str) @@ -82,7 +82,7 @@ Chapter 1. Admin Guide 3.9. xcap_server (str) 3.10. passive_mode(int) - 4. Exported Functions + 4. Functions 4.1. pres_check_basic(presentity_uri, status) 4.2. pres_check_activities(presentity_uri, activity) @@ -127,7 +127,7 @@ Chapter 1. Admin Guide running Kamailio with this module loaded: * libxml. -3. Exported Parameters +3. Parameters 3.1. db_url(str) 3.2. xcap_table(str) @@ -236,14 +236,15 @@ modparam("presence_xml", "pidf_manipulation", 1) 3.8. integrated_xcap_server (int) - This parameter is a flag for the type of XCAP server or servers used. - If the XCAP server is integrated with Kamailio presence_XML module and - access the same database tables directly, like the XCAP-lite server - from AG Projects, the parameter should be set to a positive value. - Apart from updating in xcap table, the integrated server must send an - MI command refershWatchers [pres_uri] [event] when a user modifies a - rules document, to instruct the presence_xml module to update states - from the database and, if needed, send NOTIFY updates. + This parameter is a flag for the type of XCAP servers used. If the XCAP + server is integrated with Kamailio presence_xml module and access the + same database tables directly, like the embedded XCAP server + implemented in xcap_server module, the parameter should be set to a + positive value. Apart from updating in xcap table, if the integrated + server is not running on the same Kamailio instance, it must send an MI + command refershWatchers [pres_uri] [event] when a user modifies a rules + document, to instruct the presence_xml module to update states from the + database and, if needed, send NOTIFY updates. Otherwise, it uses xcap_client module to fetch documents from the XCAP servers with HTTP requests. This mode is currently not supported. @@ -281,7 +282,7 @@ modparam("presence_xml", "xcap_server", "xcap_server.ag.org") modparam("presence_xml", "passive_mode", 1) ... -4. Exported Functions +4. Functions 4.1. pres_check_basic(presentity_uri, status) 4.2. pres_check_activities(presentity_uri, activity) diff --git a/modules_k/presence_xml/doc/presence_xml_admin.xml b/modules_k/presence_xml/doc/presence_xml_admin.xml index b7832a9..ffab8b9 100644 --- a/modules_k/presence_xml/doc/presence_xml_admin.xml +++ b/modules_k/presence_xml/doc/presence_xml_admin.xml @@ -246,12 +246,13 @@ modparam("presence_xml", "pidf_manipulation", 1) <section> <title><varname>integrated_xcap_server</varname> (int)</title> <para> - This parameter is a flag for the type of XCAP server or servers - used. If the XCAP server is integrated with &kamailio; presence_XML - module and access the same database tables directly, like the XCAP-lite - server from AG Projects, the parameter should be + This parameter is a flag for the type of XCAP servers + used. If the XCAP server is integrated with &kamailio; presence_xml + module and access the same database tables directly, like the embedded + XCAP server implemented in xcap_server module, the parameter should be set to a positive value. Apart from updating in xcap table, - the integrated server must send an MI command refershWatchers + if the integrated server is not running on the same &kamailio; instance, + it must send an MI command refershWatchers [pres_uri] [event] when a user modifies a rules document, to instruct the presence_xml module to update states from the database and, if needed, send NOTIFY updates.