tm Add improved documentation for t_replicate
authorOlle E. Johansson <oej@edvina.net>
Thu, 14 Apr 2016 08:07:53 +0000 (10:07 +0200)
committerOlle E. Johansson <oej@edvina.net>
Thu, 14 Apr 2016 08:07:53 +0000 (10:07 +0200)
modules/tm/README
modules/tm/doc/functions.xml

index 9b31ebc..40cee22 100644 (file)
@@ -2585,7 +2585,9 @@ if(!t_relay()) {
 
 5.46. t_replicate([params])
 
-   Replicate the SIP request to a specific address.
+   Replicate the SIP request to a specific address. Return values are the
+   same as for t_relay(). Note that responses to the replicated request
+   are suppressed and will not show up in any reply_route.
 
    There are several function prototypes:
      * t_replicate([uri]),
index b022fd9..4ad34fc 100644 (file)
@@ -1508,7 +1508,10 @@ if(!t_relay()) {
            <function>t_replicate([params])</function>
        </title>
        <para>
-               Replicate the SIP request to a specific address.
+               Replicate the SIP request to a specific address. Return
+               values are the same as for <function>t_relay()</function>.
+               Note that responses to the replicated request are suppressed
+               and will not show up in any reply_route.
        </para>
        <para>
                There are several function prototypes: