Module: sip-router
Branch: pd/outbound
Commit: b0ee720bec6d188615b98e8b107100fc5158e839
URL:    
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b0ee720bec6d188615b98e8b107100fc5158e839

Author: Peter Dunkley <[email protected]>
Committer: Peter Dunkley <[email protected]>
Date:   Sun Jan  6 19:32:04 2013 +0000

modules_k/rr: Updates to rr module documentation for outbound

---

 modules_k/rr/README           |    5 +++++
 modules_k/rr/doc/rr_admin.xml |   20 ++++++++++++++++++++
 2 files changed, 25 insertions(+), 0 deletions(-)

diff --git a/modules_k/rr/README b/modules_k/rr/README
index d7ec9ff..b06521c 100644
--- a/modules_k/rr/README
+++ b/modules_k/rr/README
@@ -321,6 +321,11 @@ modparam("rr", "enable_socket_mismatch_warning", 0)
    details (grep for “route set” is a good starting point in this
    comprehensive RFC).
 
+   Return codes:
+     * 1 - route calculation has been successful
+     * -1 - route calculation has been unsuccessful
+     * -2 - outbound flow-token shows evidence of tampering
+
    This function can be used from REQUEST_ROUTE.
 
    Example 1.7. loose_route usage
diff --git a/modules_k/rr/doc/rr_admin.xml b/modules_k/rr/doc/rr_admin.xml
index 1d77e5a..3162b70 100644
--- a/modules_k/rr/doc/rr_admin.xml
+++ b/modules_k/rr/doc/rr_admin.xml
@@ -292,6 +292,26 @@ modparam("rr", "enable_socket_mismatch_warning", 0)
                this comprehensive RFC).
                </para>
                <para>
+               Return codes:
+               </para>
+               <itemizedlist>
+               <listitem>
+                       <para>
+                       <emphasis>1</emphasis> - route calculation has been 
successful
+                       </para>
+               </listitem>
+               <listitem>
+                       <para>
+                       <emphasis>-1</emphasis> - route calculation has been 
unsuccessful
+                       </para>
+               </listitem>
+               <listitem>
+                       <para>
+                       <emphasis>-2</emphasis> - outbound flow-token shows 
evidence of tampering
+                       </para>
+               </listitem>
+               </itemizedlist>
+               <para>
                This function can be used from REQUEST_ROUTE.
                </para>
                <example>


_______________________________________________
sr-dev mailing list
[email protected]
http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev

Reply via email to