Skip to content

Commit

Permalink
siptrace: docs for sip_trace_mode() function
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Oct 1, 2019
1 parent 929ff14 commit 3033a26
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion src/modules/siptrace/doc/siptrace_admin.xml
Expand Up @@ -512,7 +512,7 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
</example>
</section>
</section>

<section>
<title>Functions</title>
<section id="siptrace.f.sip_trace">
Expand Down Expand Up @@ -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>
Expand Down

0 comments on commit 3033a26

Please sign in to comment.