[sr-dev] git:master:3033a26a: siptrace: docs for sip_trace_mode() function

Module: kamailio Branch: master Commit: 3033a26a6a8a8e7075dd5a86bf376c73830f2bbe URL: https://github.com/kamailio/kamailio/commit/3033a26a6a8a8e7075dd5a86bf376c7… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2019-10-01T13:31:47+02:00 siptrace: docs for sip_trace_mode() function --- Modified: src/modules/siptrace/doc/siptrace_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/3033a26a6a8a8e7075dd5a86bf376c7… Patch: https://github.com/kamailio/kamailio/commit/3033a26a6a8a8e7075dd5a86bf376c7… --- diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml index 21d6090c74..df8fe2f017 100644 --- a/src/modules/siptrace/doc/siptrace_admin.xml +++ b/src/modules/siptrace/doc/siptrace_admin.xml @@ -512,7 +512,7 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia") </example> </section> </section> - + <section> <title>Functions</title> <section id="siptrace.f.sip_trace"> @@ -569,6 +569,35 @@ sip_trace("sip:10.1.1.2:5085", "$ci-abc", "d"); </example> </section> + <section id="siptrace.f.sip_trace_mode"> + <title> + <function moreinfo="none">sip_trace_mode(tmode])</function> + </title> + <para> + Set the tracing mode: message, transaction or dialog. Only the first + character of the parameter matters: m or M for message; t or T for + transaction; d or D for dialog. + </para> + <para> + In message tracing mode only the current message is stored or mirrored. + In transaction tracing mode, all the messages of the current transaction + are stored or mirrored. In dialog tracing mode, all the messages of the + current dialog are stored or mirrored. + </para> + <para> + This function can be used in ANY_ROUTE. + </para> + </emphasis> + <example> + <title><function>sip_trace_mode()</function> usage</title> + <programlisting format="linespecific"> +... +sip_trace_mode("t"); +... +</programlisting> + </example> + </section> + <section id="siptrace.f.hlog"> <title> <function moreinfo="none">hlog([correlation_id,] message)</function>