Skip to content

Commit

Permalink
modules: readme files regenerated - modules ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed Apr 8, 2020
1 parent fa02f43 commit be8aac4
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions src/modules/rr/README
Expand Up @@ -170,8 +170,8 @@ Chapter 1. Admin Guide
3261 (see 12.1.1 UAS behavior).

For this purpose, the modules offers the following functions:
* add_rr_param() - see ???
* check_route_param() - see ???
* add_rr_param() - see Section 5.6, “add_rr_param(param)”
* check_route_param() - see Section 5.7, “check_route_param(re)”

Example 1.1. Dialog support in RR module
...
Expand Down Expand Up @@ -515,8 +515,9 @@ record_route_advertised_address("1.2.3.4:5080");

Adds a parameter to the Record-Route URI (param must be in
“;name=value” format. The function may be called also before or after
the record_route() or record_route_advertised_address() calls (see ???
or ???)).
the record_route() or record_route_advertised_address() calls (see
Section 5.2, “record_route([sparams])” or Section 5.5,
“record_route_advertised_address(address)”)).

Meaning of the parameters is as follows:
* param - String containing the URI parameter to be added. It must
Expand All @@ -534,7 +535,8 @@ add_rr_param(";nat=yes");

The function checks if the URI parameters of the local Route header
(corresponding to the local server) matches the given regular
expression. It must be call after loose_route() (see ???).
expression. It must be call after loose_route() (see Section 5.1,
“loose_route()”).

Meaning of the parameters is as follows:
* re - regular expression to check against the Route URI parameters.
Expand All @@ -553,7 +555,8 @@ if (check_route_param("nat=yes")) {
The function checks the flow direction of in-dialog requests. This
function uses the “ftag” parameter from the Route header, therefore the
append_fromtag (see ??? module parameter must be enabled. Also this
must be called only after loose_route() (see ???).
must be called only after loose_route() (see Section 5.1,
“loose_route()”).

The function returns true if the “dir” is the same with the request's
flow direction.
Expand Down

0 comments on commit be8aac4

Please sign in to comment.