Module: kamailio Branch: master Commit: 41a48b519c238945b40cf1570e68abaf347fba07 URL: https://github.com/kamailio/kamailio/commit/41a48b519c238945b40cf1570e68abaf...

Author: Daniel-Constantin Mierla miconda@gmail.com Committer: Daniel-Constantin Mierla miconda@gmail.com Date: 2025-03-19T07:59:32+01:00

tcpops: docs for tcp_con_alive()

---

Modified: src/modules/tcpops/doc/functions.xml

---

Diff: https://github.com/kamailio/kamailio/commit/41a48b519c238945b40cf1570e68abaf... Patch: https://github.com/kamailio/kamailio/commit/41a48b519c238945b40cf1570e68abaf...

---

diff --git a/src/modules/tcpops/doc/functions.xml b/src/modules/tcpops/doc/functions.xml index 85f7369f88b..2ee00a58525 100644 --- a/src/modules/tcpops/doc/functions.xml +++ b/src/modules/tcpops/doc/functions.xml @@ -40,6 +40,36 @@ if(!tcp_conid_alive("$var(conid)")) { xlog("L_ERR", "Connection $conid can no longer be used\n"); } +... + ]]></programlisting> + </example> + </section> + <section id="tcpops.f.tcp_con_alive"> + <title> + <function>tcp_con_alive(hostport)</function> + </title> + <para> + Check the connection based on target host:port. + </para> + <para>Meaning of the parameters is as follows:</para> + <itemizedlist> + <listitem> + <para><emphasis>hostport</emphasis> - target "host:port" address, + the port can be omitted (default to 5060) and the parameter can + contain variables. + </para> + </listitem> + </itemizedlist> + <para>Return values:</para> + <para>1: connection was found</para> + <para>-1: connection was not found or an error occurred</para> + <example> + <title><function>tcp_con_alive</function> usage</title> + <programlisting><![CDATA[ +... + if(!tcp_con_alive("1.2.3.4:5060")) { + xlog("connection not found\n"); + } ... ]]></programlisting> </example>