[sr-dev] git:master: pua_usrloc: documented branch_flag parameter

Module: sip-router Branch: master Commit: 266fa4e2cd62f58ee1f2eec2a5a83bc3028d194a URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=266fa4e… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Fri Jan 20 19:04:21 2012 +0100 pua_usrloc: documented branch_flag parameter --- modules_k/pua_usrloc/README | 28 +++++++++++++++++++----- modules_k/pua_usrloc/doc/pua_usrloc_admin.xml | 20 +++++++++++++++++ 2 files changed, 42 insertions(+), 6 deletions(-) diff --git a/modules_k/pua_usrloc/README b/modules_k/pua_usrloc/README index 8daadfc..65e1f87 100644 --- a/modules_k/pua_usrloc/README +++ b/modules_k/pua_usrloc/README @@ -8,7 +8,7 @@ Edited by Anca-Maria Vamanu - Copyright © 2006 Voice Sistem SRL + Copyright � 2006 Voice Sistem SRL __________________________________________________________________ Table of Contents @@ -25,6 +25,7 @@ Anca-Maria Vamanu 3.1. default_domain (str) 3.2. entity_prefix (str) + 3.3. branch_flag (int) 4. Functions @@ -34,7 +35,8 @@ Anca-Maria Vamanu 1.1. Set default_domain parameter 1.2. Set presentity_prefix parameter - 1.3. pua_set_publish usage + 1.3. Set branch_flag parameter + 1.4. pua_set_publish usage Chapter 1. Admin Guide @@ -50,6 +52,7 @@ Chapter 1. Admin Guide 3.1. default_domain (str) 3.2. entity_prefix (str) + 3.3. branch_flag (int) 4. Functions @@ -87,13 +90,14 @@ Chapter 1. Admin Guide 3.1. default_domain (str) 3.2. entity_prefix (str) + 3.3. branch_flag (int) 3.1. default_domain (str) The default domain to use when constructing the presentity URI if it is missing from recorded AOR. - Default value is “NULL”. + Default value is "NULL". Example 1.1. Set default_domain parameter ... @@ -105,24 +109,36 @@ modparam("pua_usrloc", "default_domain", "kamailio.org") The prefix when construstructing entity attribute to be added to presence node in XML PIDF. (ex: pres:user@domain ). - Default value is “NULL”. + Default value is "NULL". Example 1.2. Set presentity_prefix parameter ... modparam("pua_usrloc", "entity_prefix", "pres") ... +3.3. branch_flag (int) + + Which branch flag to be used to select the contact addresses for which + to generate PUBLISH. Valid values are 0 to 31. + + Default value is "-1" (disabled). + + Example 1.3. Set branch_flag parameter +... +modparam("pua_usrloc", "branch_flag", 9) +... + 4. Functions 4.1. pua_set_publish() -4.1. pua_set_publish() +4.1. pua_set_publish() The function is used to mark REGISTER requests that have to issue a PUBLISH. The PUBLISH is issued when REGISTER is saved in location table. - Example 1.3. pua_set_publish usage + Example 1.4. pua_set_publish usage ... if(is_method("REGISTER") && from_uri=~&quot;john(a)kamailio.org&quot;) pua_set_publish(); diff --git a/modules_k/pua_usrloc/doc/pua_usrloc_admin.xml b/modules_k/pua_usrloc/doc/pua_usrloc_admin.xml index 50f1676..3e85a89 100644 --- a/modules_k/pua_usrloc/doc/pua_usrloc_admin.xml +++ b/modules_k/pua_usrloc/doc/pua_usrloc_admin.xml @@ -104,6 +104,26 @@ modparam("pua_usrloc", "entity_prefix", "pres") </example> </section> + <section> + <title><varname>branch_flag</varname> (int)</title> + <para> + Which branch flag to be used to select the contact addresses for which + to generate PUBLISH. Valid values are 0 to 31. + </para> + <para> + <emphasis>Default value is <quote>-1</quote> (disabled). + </emphasis> + </para> + <example> + <title>Set <varname>branch_flag</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("pua_usrloc", "branch_flag", 9) +... +</programlisting> + </example> + </section> + </section> <section> <title>Functions</title>