[sr-dev] git:master:33c3f355: pv: docs for xavp_push_dst()

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2022-05-13T16:03:40+02:00

pv: docs for xavp_push_dst()

---

Modified: src/modules/pv/doc/pv_admin.xml

---

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

---

diff --git a/src/modules/pv/doc/pv_admin.xml b/src/modules/pv/doc/pv_admin.xml
index bc36df564b..409ecaa4da 100644
--- a/src/modules/pv/doc/pv_admin.xml
+++ b/src/modules/pv/doc/pv_admin.xml
@@ -765,6 +765,48 @@ $xavp(n) = 20;
 $xavp(n) = 30;
 xavp_lshift("n", "1");
 # results in: $xavp(n) having the list of values 20 30 10
+...
+				</programlisting>
+			</example>
+		</section>
+		<section id="pv.f.xavp_push_dst">
+			<title>
+				<function moreinfo="none">xavp_push_dst(xname)</function>
+			</title>
+			<para>
+				Set destination fields from XAVP attributes.
+			</para>
+			<para>
+				The first parameter has to be the name of XAVP in the root list.
+			</para>
+			<para>
+				The parameters can be with variables.
+			</para>
+			<para>
+				The attributes that can be stored in the XAVP fields:
+			</para>
+			<itemizedlist>
+				<listitem>
+					<para>uri: SIP URI address to set R-URI</para>
+				</listitem>
+				<listitem>
+					<para>dsturi: SIP URI address to set DST-URI</para>
+				</listitem>
+				<listitem>
+					<para>socket: listen address to set outgoing socket</para>
+				</listitem>
+			</itemizedlist>
+			<para>
+			Function can be used from REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE.
+			</para>
+			<example>
+				<title><function>xavp_push_dst</function> usage</title>
+				<programlisting format="linespecific">
+...
+$xavp(dst=>uri) = "sip:alice at server.com";
+$xavp(dst[0]=>dsturi) = "sip:proxy.com";
+$xavp(dst[0]=>socket) = "udp:1.2.3.4:5060";
+xavp_push_dst("dst");
 ...
 				</programlisting>
 			</example>