Browse code

pv: docs for xavp_push_dst()

Daniel-Constantin Mierla authored on 13/05/2022 14:03:40
Showing 1 changed files
... ...
@@ -765,6 +765,48 @@ $xavp(n) = 20;
765 765
 $xavp(n) = 30;
766 766
 xavp_lshift("n", "1");
767 767
 # results in: $xavp(n) having the list of values 20 30 10
768
+...
769
+				</programlisting>
770
+			</example>
771
+		</section>
772
+		<section id="pv.f.xavp_push_dst">
773
+			<title>
774
+				<function moreinfo="none">xavp_push_dst(xname)</function>
775
+			</title>
776
+			<para>
777
+				Set destination fields from XAVP attributes.
778
+			</para>
779
+			<para>
780
+				The first parameter has to be the name of XAVP in the root list.
781
+			</para>
782
+			<para>
783
+				The parameters can be with variables.
784
+			</para>
785
+			<para>
786
+				The attributes that can be stored in the XAVP fields:
787
+			</para>
788
+			<itemizedlist>
789
+				<listitem>
790
+					<para>uri: SIP URI address to set R-URI</para>
791
+				</listitem>
792
+				<listitem>
793
+					<para>dsturi: SIP URI address to set DST-URI</para>
794
+				</listitem>
795
+				<listitem>
796
+					<para>socket: listen address to set outgoing socket</para>
797
+				</listitem>
798
+			</itemizedlist>
799
+			<para>
800
+			Function can be used from REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE.
801
+			</para>
802
+			<example>
803
+				<title><function>xavp_push_dst</function> usage</title>
804
+				<programlisting format="linespecific">
805
+...
806
+$xavp(dst=&gt;uri) = "sip:alice@server.com";
807
+$xavp(dst[0]=&gt;dsturi) = "sip:proxy.com";
808
+$xavp(dst[0]=&gt;socket) = "udp:1.2.3.4:5060";
809
+xavp_push_dst("dst");
768 810
 ...
769 811
 				</programlisting>
770 812
 			</example>