[sr-dev] git:master:fd5a0b89: rr: docs for loose_route_preloaded()

Module: kamailio Branch: master Commit: fd5a0b890028887b4cb1cd7ac2be2cf37d27956f URL: https://github.com/kamailio/kamailio/commit/fd5a0b890028887b4cb1cd7ac2be2cf… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2020-04-07T10:04:54+02:00 rr: docs for loose_route_preloaded() --- Modified: src/modules/rr/doc/rr_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/fd5a0b890028887b4cb1cd7ac2be2cf… Patch: https://github.com/kamailio/kamailio/commit/fd5a0b890028887b4cb1cd7ac2be2cf… --- diff --git a/src/modules/rr/doc/rr_admin.xml b/src/modules/rr/doc/rr_admin.xml index bdb78291b6..bce2042d05 100644 --- a/src/modules/rr/doc/rr_admin.xml +++ b/src/modules/rr/doc/rr_admin.xml @@ -416,6 +416,33 @@ loose_route(); </example> </section> + <section id="rr.f.loose_route_preloaded"> + <title><function moreinfo="none">loose_route_preloaded()</function></title> + + <para>The function is similar to `loose_route()`, but it returns 1 (true) + when the Route header is preloaded (is in an initial request) and -1 + (false) if processing of the Route header failed or it is for requests + within dialog.</para> + <para>It is a convenient function to use for routing initial requests on + an edge proxy that adds Path header to REGISTER requests. + </para> + <para>This function can be used from REQUEST_ROUTE.</para> + + <example> + <title><function>loose_route_preloaded</function> usage</title> + + <programlisting format="linespecific"> +... +if(!loose_route_preloaded()) { + sl_send_reply("404" "Preloaded route expected"); + exit; +} +... +</programlisting> + </example> + </section> + + <section id="rr.f.record_route"> <title><function moreinfo="none">record_route([sparams])</function></title>