git:master: uac: Add note about only using uac_replace once in the same request - sr-dev

20 Dec 2012

Module: sip-router
Branch: master
Commit: 1c35849b76ea9257162d5977e839399027c9659b
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=1c35849b...
Author: Olle E. Johansson oej@edvina.net
Committer: Olle E. Johansson oej@edvina.net
Date:   Thu Dec 20 13:44:59 2012 +0100
uac: Add note about only using uac_replace once in the same request
---
modules_k/uac/doc/uac_admin.xml |   19 +++++++++++++------
 1 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/modules_k/uac/doc/uac_admin.xml b/modules_k/uac/doc/uac_admin.xml
index 5e3b70a..147b6e1 100644
--- a/modules_k/uac/doc/uac_admin.xml
+++ b/modules_k/uac/doc/uac_admin.xml
@@ -19,16 +19,16 @@
    	<para>
    	The <acronym>UAC</acronym> (User Agent Client) module provides some basic UAC
    	functionalities like sending SIP requests, registering with a remote service,
-		FROM header manipulation (anonymization) and client authentication.
+		From: header manipulation (anonymization) and client authentication.
    	</para>
    	<para>
-		From version 1.5.0 it has function to send SIP message from
+		The UAC module also supports sending a SIP request from the
    	configuration file. See variable $uac_req(name) and the function
    	uac_req_send().
    	</para>
    	<para>
-		Version 3.1.0 adds database-driven SIP registration functionality. See
-		uac_reg_lookup() function and dedicated section for remote
+		In addition, the module supports database-driven SIP registration functionality. See
+		the uac_reg_lookup() function and dedicated section for remote
    	registration configuration.
    	</para>
    	<para>
@@ -46,6 +46,13 @@
    			may be rejected.
    		</para>
    		</listitem>
+			<listitem>
+			<para>
+				The <quote>uac_replace_*</quote> functions can only be run once on the same
+				SIP request. Try to save needed changes in a pseudovariable and
+				apply them once.
+			</para>
+			</listitem>
    	</itemizedlist>
    </section>
@@ -64,13 +71,13 @@
    		<listitem>
    		<para>
    			<emphasis>RR - Record-Route Module</emphasis>, but only if
-				restore mode for FROM URI is set to <quote>auto</quote>.
+				restore mode for From: URI is set to <quote>auto</quote>.
    		</para>
    		</listitem>
    		<listitem>
    		<para>
    			<emphasis>Dialog Module</emphasis>, but only if
-				restore mode for FROM URI is set to <quote>auto</quote> and
+				restore mode for From: URI is set to <quote>auto</quote> and
    			you want uac_replace_from or uac_replace_to to store the values
    			of the URIs as dialog variables.
    		</para>

    