Skip to content

Commit

Permalink
sipdump: docs for mode and event_callback parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Jan 22, 2020
1 parent 801eaa9 commit 3a6a55a
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion src/modules/sipdump/doc/sipdump_admin.xml
Expand Up @@ -76,7 +76,7 @@
<section id="sipdump.p.enable">
<title><varname>enable</varname> (int)</title>
<para>
Enable storage.
Enable sipdump activity.
</para>
<para>
<emphasis>
Expand All @@ -89,6 +89,26 @@
...
modparam("sipdump", "enable", 1)
...
</programlisting>
</example>
</section>
<section id="sipdump.p.mode">
<title><varname>mode</varname> (int)</title>
<para>
Set the type of activity done by the module, the value can be set
based on flags: 1 - write to files; 2 - execute event route
</para>
<para>
<emphasis>
Default value is 1 (write to files).
</emphasis>
</para>
<example>
<title>Set <varname>mode</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("sipdump", "mode", 3)
...
</programlisting>
</example>
</section>
Expand Down Expand Up @@ -166,6 +186,31 @@ modparam("sipdump", "folder", "/run/kamailio")
...
modparam("sipdump", "fprefix", "ksipdump-")
...
</programlisting>
</example>
</section>
<section id="sipdump.p.event_callback">
<title><varname>event_callback</varname> (str)</title>
<para>
Name of the KEMI function to be executed instead of the event route.
</para>
<para>
<emphasis>
Default value is not set.
</emphasis>
</para>
<example>
<title>Set <varname>event_callback</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("sipdump", "event_callback", "ksr_sipdump_event")
...
-- event callback function implemented in Lua
function ksr_sipdump_event(evname)
KSR.info("===== sipdump module triggered event: " .. evname .. "\n");
return 1;
end
...
</programlisting>
</example>
</section>
Expand Down

0 comments on commit 3a6a55a

Please sign in to comment.