[sr-dev] git:master:bdba22bb: rtpengine: docs updated for rtpengine_manage()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: bdba22bb9b573c7b32a7de45154f9159c725715f
URL: https://github.com/kamailio/kamailio/commit/bdba22bb9b573c7b32a7de45154f9159c725715f

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-02-23T12:29:44+01:00

rtpengine: docs updated for rtpengine_manage()

---

Modified: src/modules/rtpengine/doc/rtpengine_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/bdba22bb9b573c7b32a7de45154f9159c725715f.diff
Patch: https://github.com/kamailio/kamailio/commit/bdba22bb9b573c7b32a7de45154f9159c725715f.patch

---

diff --git a/src/modules/rtpengine/doc/rtpengine_admin.xml b/src/modules/rtpengine/doc/rtpengine_admin.xml
index f4213f2cab..fafff2e4c5 100644
--- a/src/modules/rtpengine/doc/rtpengine_admin.xml
+++ b/src/modules/rtpengine/doc/rtpengine_admin.xml
@@ -2564,7 +2564,7 @@ rtpengine_query();
         <function moreinfo="none">rtpengine_manage([flags])</function>
         </title>
 		<para>
-		Manage the RTPProxy session - it combines the functionality of
+		Manage the RTPEngine session - it combines the functionality of
 		rtpengine_offer(), rtpengine_answer() and rtpengine_delete(), detecting
 		internally based on message type and method which one to execute.
 		</para>
@@ -2601,7 +2601,14 @@ rtpengine_query();
 			this function after resuming a suspended transaction (e.g., after
 			t_continue()), because the context of executed route is FAILURE
 			ROUTE (in other words, rtpengine_manage() in the route block of
-			t_continue() does the same as in failure_route).
+			t_continue() does the same as in failure_route; use a branch route
+			to engage rtpengine for a forwarded branch after resuming the
+			transaction).
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			It does nothing if used inside event_route[tm:branch-failure:...]
 			</para>
 		</listitem>
 		<listitem>