[sr-dev] git:master:2ea7dc36: corex: docs for is_faked_msg() function

Module: kamailio Branch: master Commit: 2ea7dc363b15259468fb1518208b87d3e2b6289c URL: https://github.com/kamailio/kamailio/commit/2ea7dc363b15259468fb1518208b87d… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2020-04-16T16:52:30+02:00 corex: docs for is_faked_msg() function --- Modified: src/modules/corex/doc/corex_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/2ea7dc363b15259468fb1518208b87d… Patch: https://github.com/kamailio/kamailio/commit/2ea7dc363b15259468fb1518208b87d… --- diff --git a/src/modules/corex/doc/corex_admin.xml b/src/modules/corex/doc/corex_admin.xml index 98c51f1470..b35efd1047 100644 --- a/src/modules/corex/doc/corex_admin.xml +++ b/src/modules/corex/doc/corex_admin.xml @@ -765,6 +765,36 @@ request_route { </programlisting> </example> </section> + <section id="corex.f.is_faked_msg"> + <title> + <function moreinfo="none">is_faked_msg()</function> + </title> + <para> + Returns 1 (native config true) if the SIP message under processing + is the internal faked msg structure. Returns -1 (native config false) + if the SIP message under processing is received from the network. + </para> + <para> + The function should be useful in event route blocks or async route + blocks where it can be processed either a message from the network + or the internal faked message. + </para> + <para> + This function can be used in ANY_ROUTE. + </para> + <example> + <title><function>is_faked_msg</function> usage</title> + <programlisting format="linespecific"> +... +event_route[dispatcher:dst-down] { + if (is_faked_msg()) { + xinfo("Running with faked message\n"); + } +} +... +</programlisting> + </example> + </section> </section> <section>