[sr-dev] git:master:cb8f9876: corex: docs for is_socket_name()

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2021-02-25T16:57:53+01:00

corex: docs for is_socket_name()

---

Modified: src/modules/corex/doc/corex_admin.xml

---

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

---

diff --git a/src/modules/corex/doc/corex_admin.xml b/src/modules/corex/doc/corex_admin.xml
index c594c97d0b..5ae9bea44a 100644
--- a/src/modules/corex/doc/corex_admin.xml
+++ b/src/modules/corex/doc/corex_admin.xml
@@ -866,6 +866,29 @@ event_route[dispatcher:dst-down] {
     }
 }
 ...
+</programlisting>
+        </example>
+    </section>
+	<section id="corex.f.is_socket_name">
+		<title>
+			<function moreinfo="none">is_socket_name(sockname)</function>
+		</title>
+        <para>
+			Returns 1 (native config true) if the parameter matches a local
+			socket name, otherwise -1 (native config false). The parameter can
+			contain variables.
+        </para>
+        <para>
+        This function can be used in ANY_ROUTE.
+        </para>
+        <example>
+        <title><function>is_socket_name</function> usage</title>
+        <programlisting format="linespecific">
+...
+    if (is_socket_name("socktls")) {
+        xinfo("matched local socket name\n");
+    }
+...
 </programlisting>
         </example>
     </section>