Skip to content

Commit

Permalink
rr: docs for loose_route_preloaded()
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Apr 7, 2020
1 parent 4cdd0b4 commit fd5a0b8
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions src/modules/rr/doc/rr_admin.xml
Expand Up @@ -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>

Expand Down

0 comments on commit fd5a0b8

Please sign in to comment.