Explorar el Código

pua_usrloc: documented branch_flag parameter

Daniel-Constantin Mierla hace 13 años
padre
commit
266fa4e2cd
Se han modificado 2 ficheros con 42 adiciones y 6 borrados
  1. 22 6
      modules_k/pua_usrloc/README
  2. 20 0
      modules_k/pua_usrloc/doc/pua_usrloc_admin.xml

+ 22 - 6
modules_k/pua_usrloc/README

@@ -8,7 +8,7 @@ Edited by
 
 
 Anca-Maria Vamanu
 Anca-Maria Vamanu
 
 
-   Copyright © 2006 Voice Sistem SRL
+   Copyright © 2006 Voice Sistem SRL
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -25,6 +25,7 @@ Anca-Maria Vamanu
 
 
               3.1. default_domain (str)
               3.1. default_domain (str)
               3.2. entity_prefix (str)
               3.2. entity_prefix (str)
+              3.3. branch_flag (int)
 
 
         4. Functions
         4. Functions
 
 
@@ -34,7 +35,8 @@ Anca-Maria Vamanu
 
 
    1.1. Set default_domain parameter
    1.1. Set default_domain parameter
    1.2. Set presentity_prefix 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
 Chapter 1. Admin Guide
 
 
@@ -50,6 +52,7 @@ Chapter 1. Admin Guide
 
 
         3.1. default_domain (str)
         3.1. default_domain (str)
         3.2. entity_prefix (str)
         3.2. entity_prefix (str)
+        3.3. branch_flag (int)
 
 
    4. Functions
    4. Functions
 
 
@@ -87,13 +90,14 @@ Chapter 1. Admin Guide
 
 
    3.1. default_domain (str)
    3.1. default_domain (str)
    3.2. entity_prefix (str)
    3.2. entity_prefix (str)
+   3.3. branch_flag (int)
 
 
 3.1. default_domain (str)
 3.1. default_domain (str)
 
 
    The default domain to use when constructing the presentity URI if it is
    The default domain to use when constructing the presentity URI if it is
    missing from recorded AOR.
    missing from recorded AOR.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
    Example 1.1. Set default_domain parameter
    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
    The prefix when construstructing entity attribute to be added to
    presence node in XML PIDF. (ex: pres:user@domain ).
    presence node in XML PIDF. (ex: pres:user@domain ).
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
    Example 1.2. Set presentity_prefix parameter
    Example 1.2. Set presentity_prefix parameter
 ...
 ...
 modparam("pua_usrloc", "entity_prefix", "pres")
 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. Functions
 
 
    4.1. pua_set_publish()
    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
    The function is used to mark REGISTER requests that have to issue a
    PUBLISH. The PUBLISH is issued when REGISTER is saved in location
    PUBLISH. The PUBLISH is issued when REGISTER is saved in location
    table.
    table.
 
 
-   Example 1.3. pua_set_publish usage
+   Example 1.4. pua_set_publish usage
 ...
 ...
 if(is_method("REGISTER") && from_uri=~"[email protected]")
 if(is_method("REGISTER") && from_uri=~"[email protected]")
         pua_set_publish();
         pua_set_publish();

+ 20 - 0
modules_k/pua_usrloc/doc/pua_usrloc_admin.xml

@@ -104,6 +104,26 @@ modparam("pua_usrloc", "entity_prefix", "pres")
 		</example>
 		</example>
 </section>
 </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>
 <section>
 <section>
 	<title>Functions</title>
 	<title>Functions</title>