[sr-dev] git:master:06aa21a9: ipops: docs for dns_set_local_ttl()

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2022-04-11T08:42:57+02:00

ipops: docs for dns_set_local_ttl()

---

Modified: src/modules/ipops/doc/ipops_admin.xml

---

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

---

diff --git a/src/modules/ipops/doc/ipops_admin.xml b/src/modules/ipops/doc/ipops_admin.xml
index a04a42ab16..9b7da7a974 100644
--- a/src/modules/ipops/doc/ipops_admin.xml
+++ b/src/modules/ipops/doc/ipops_admin.xml
@@ -1064,6 +1064,46 @@ if (naptr_query ("example.com", "res") > 0) {
 
     </section>
 
+    <section id="ipops.f.dns_set_local_ttl">
+      <title>
+        <function moreinfo="none">dns_set_local_ttl(vttl)</function>
+      </title>
+
+      <para>
+		  Set local ttl for DNS query results. If vttl is 0, then the value of
+		  the result and the core parameters are used.
+      </para>
+
+      <para>Parameters:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para>
+			  <emphasis>vttl</emphasis> - TTL value in seconds. It can be static
+			  integer or a variable holding an integer value.
+          </para>
+        </listitem>
+      </itemizedlist>
+
+      <para>
+        This function can be used from ANY_ROUTE.
+      </para>
+
+      <example>
+        <title>
+          <function>dns_set_local_ttl</function> usage
+        </title>
+        <programlisting format="linespecific">
+...
+  dns_set_local_ttl("7200");
+  dns_query("test.com", "xyz")
+  dns_set_local_ttl("0");
+...
+        </programlisting>
+      </example>
+
+    </section>
+
   </section>
- 
+
 </chapter>