[sr-dev] git:master:4ea4f598: tcpops: docs for tcp_close_connection()

Module: kamailio Branch: master Commit: 4ea4f598a10b6f0f690cf8a9b6174997ccb62b6f URL: https://github.com/kamailio/kamailio/commit/4ea4f598a10b6f0f690cf8a9b617499… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2021-06-23T08:40:46+02:00 tcpops: docs for tcp_close_connection() --- Modified: src/modules/tcpops/doc/functions.xml --- Diff: https://github.com/kamailio/kamailio/commit/4ea4f598a10b6f0f690cf8a9b617499… Patch: https://github.com/kamailio/kamailio/commit/4ea4f598a10b6f0f690cf8a9b617499… --- diff --git a/src/modules/tcpops/doc/functions.xml b/src/modules/tcpops/doc/functions.xml index 94cefaa776..1502386598 100644 --- a/src/modules/tcpops/doc/functions.xml +++ b/src/modules/tcpops/doc/functions.xml @@ -375,4 +375,40 @@ event_route[tcp:closed] { ]]></programlisting> </example> </section> + <section id="tcpops.f.tcp_close_connection"> + <title> + <function>tcp_close_connection([conid])</function> + </title> + <para> + Trigger a close of the connection corresponding to current SIP + message or to connection id 'conid'. + </para> + <para>Meaning of the parameters is as follows:</para> + <itemizedlist> + <listitem> + <para><emphasis>conid</emphasis> - the value of tcp connection id. + It can be an integer number or a variable holding an interver value. + </para> + </listitem> + </itemizedlist> + <para>Return values:</para> + <itemizedlist> + <listitem> + <para>1: success</para> + </listitem> + <listitem> + <para>-1 (or other negative values): failure</para> + </listitem> + </itemizedlist> + <example> + <title><function>tcp_close_connection</function> usage</title> + <programlisting><![CDATA[ +... + $var(conid) = 10; + tcp_close_connection("$var(conid)"); +... + ]]></programlisting> + </example> + </section> + </section>