[sr-dev] git:master:7c2afb18: pipelimit: docs for pl_active() function

Module: kamailio Branch: master Commit: 7c2afb184276ec9f5f1d896e34aad6a8a8d55039 URL: https://github.com/kamailio/kamailio/commit/7c2afb184276ec9f5f1d896e34aad6a… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2021-03-02T09:14:58+01:00 pipelimit: docs for pl_active() function --- Modified: src/modules/pipelimit/doc/pipelimit_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/7c2afb184276ec9f5f1d896e34aad6a… Patch: https://github.com/kamailio/kamailio/commit/7c2afb184276ec9f5f1d896e34aad6a… --- diff --git a/src/modules/pipelimit/doc/pipelimit_admin.xml b/src/modules/pipelimit/doc/pipelimit_admin.xml index ce470f80eb..688b19957f 100644 --- a/src/modules/pipelimit/doc/pipelimit_admin.xml +++ b/src/modules/pipelimit/doc/pipelimit_admin.xml @@ -511,6 +511,30 @@ with unexpected retcode=$var(check_result)\n"); </programlisting> </example> </section> + <section id="pipelimit.f.pl_active"> + <title> + <function moreinfo="none">pl_active(name)</function> + </title> + <para> + Check the pipe 'name' was already created. Return 1 (true) if the pipe + is found, -1 (false) if the pipe is not found. + </para> + <para> + This function can be used from ANY_ROUTE. + </para> + <example> + <title><function>pl_active</function> usage</title> + <programlisting format="linespecific"> +... + if (!pl_active("one")) { + # pipe does not exist + exit; + } +... +</programlisting> + </example> + </section> + <section id="pipelimit.f.pl_drop"> <title> <function moreinfo="none">pl_drop([ [min ], max ])</function>