[sr-dev] git:master:0530de0d: topoh: documentation for event_route[topoh:msg-outgoing]

Module: kamailio Branch: master Commit: 0530de0df83e30f9d5bc544e1716a5eb22d2c39d URL: https://github.com/kamailio/kamailio/commit/0530de0df83e30f9d5bc544e1716a5e… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2017-06-15T17:08:55+02:00 topoh: documentation for event_route[topoh:msg-outgoing] --- Modified: src/modules/topoh/doc/topoh_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/0530de0df83e30f9d5bc544e1716a5e… Patch: https://github.com/kamailio/kamailio/commit/0530de0df83e30f9d5bc544e1716a5e… --- diff --git a/src/modules/topoh/doc/topoh_admin.xml b/src/modules/topoh/doc/topoh_admin.xml index 2d92f21e47..c3366dd735 100644 --- a/src/modules/topoh/doc/topoh_admin.xml +++ b/src/modules/topoh/doc/topoh_admin.xml @@ -10,9 +10,9 @@ <!-- Module User's Guide --> <chapter> - + <title>&adminguide;</title> - + <section> <title>Overview</title> <para> @@ -253,7 +253,37 @@ modparam("topoh", "sanity_checks", 1) </programlisting> </example> </section> + </section> + <section> + <title>Event Routes</title> + <section> + <title>event_route[topoh:msg-outgoing]</title> + <para> + It is executed before doing topology hiding processing for an outgoing + SIP message. If 'drop' is executed inside the event route, then the + module skips doing the topology hiding. + </para> + <para> + Inside the event route the variables $sndto(ip), $sndto(port) and + $sndto(proto) point to the destination. The SIP message is not the one + to be sent out, but an internally generated one at startup, to avoid + reparsing the outgoing SIP message for the cases when topology hiding + is not wanted. + </para> + <example> + <title>Usage of event_route[topoh:msg-outgoing]</title> + <programlisting format="linespecific"> +... +event_route[topoh:msg-outgoing] { + if($sndto(ip)=="10.1.1.10") { + drop; + } +} +... +</programlisting> + </example> + </section> </section> </chapter>