[sr-dev] git:master:e9eeb088: siptrace: docs for evcb_msg param and event_route[siptrace:msg]

Module: kamailio Branch: master Commit: e9eeb0881569f77bcdd9d9590bfa0d9cf144b4a4 URL: https://github.com/kamailio/kamailio/commit/e9eeb0881569f77bcdd9d9590bfa0d9… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2020-07-13T12:33:50+02:00 siptrace: docs for evcb_msg param and event_route[siptrace:msg] --- Modified: src/modules/siptrace/doc/siptrace_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/e9eeb0881569f77bcdd9d9590bfa0d9… Patch: https://github.com/kamailio/kamailio/commit/e9eeb0881569f77bcdd9d9590bfa0d9… --- diff --git a/src/modules/siptrace/doc/siptrace_admin.xml b/src/modules/siptrace/doc/siptrace_admin.xml index 7d5b0d34ef..6966289a69 100644 --- a/src/modules/siptrace/doc/siptrace_admin.xml +++ b/src/modules/siptrace/doc/siptrace_admin.xml @@ -629,6 +629,25 @@ Supported on HEPv3 only. ... modparam("siptrace", "auth_key", "spoihepuirthpeuia") ... +</programlisting> + </example> + </section> + <section id="siptrace.p.evcb_msg"> + <title><varname>evcb_msg</varname> (str)</title> + <para> + Set the name of KEMI function to be executed instead of + event_route[siptrace:msg]. + </para> + <para> + Default value is empty. + </para> + <example> + <title>Set <varname>evcb_msg</varname> + parameter</title> + <programlisting format="linespecific"> +... +modparam("siptrace", "evcb_msg", "ksr_siptrace_msg") +... </programlisting> </example> </section> @@ -794,6 +813,33 @@ hlog("$hdr(P-MyID)", "Another one with a custom correlation ID"); </section> </section><!-- RPC commands --> + <section> + <title>Event Routes</title> + <section id="siptrace.ev.siptrace_msg"> + <title> + <function moreinfo="none">event_route[siptrace:msg]</function> + </title> + <para> + The event route is executed when mirroring SIP traffic using core event + callbacks (data in/out on network). If drop() is used, then the mirroring + is no longer done. + </para> + <para> + Note: now only message content (e.g., headers, body) can be used for + conditions in the event route, the source and destination addresses are + not yet available. + </para> + <programlisting format="linespecific"> +... +event_route[siptrace:msg] { + if(is_method("OPTIONS")) { + drop(); + } +} +... + </programlisting> + </section> + </section><!-- event routes --> <section> <title>Database setup</title> <para>