Module: kamailio Branch: master Commit: 744c954f268dee56764ed408172b7d04b536bbff URL: https://github.com/kamailio/kamailio/commit/744c954f268dee56764ed408172b7d04...

Author: Kamailio Dev kamailio.dev@kamailio.org Committer: Kamailio Dev kamailio.dev@kamailio.org Date: 2020-04-08T12:46:24+02:00

modules: readme files regenerated - rr ... [skip ci]

---

Modified: src/modules/rr/README

---

Diff: https://github.com/kamailio/kamailio/commit/744c954f268dee56764ed408172b7d04... Patch: https://github.com/kamailio/kamailio/commit/744c954f268dee56764ed408172b7d04...

---

diff --git a/src/modules/rr/README b/src/modules/rr/README index b97c569f85..9f3917c484 100644 --- a/src/modules/rr/README +++ b/src/modules/rr/README @@ -179,8 +179,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.7, “add_rr_param(param)” + * check_route_param() - see Section 5.8, “check_route_param(re)”

Example 1.1. Dialog support in RR module ... @@ -559,8 +559,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.3, “record_route([sparams])” or Section 5.6, + “record_route_advertised_address(address)”)).

Meaning of the parameters is as follows: * param - String containing the URI parameter to be added. It must @@ -578,7 +579,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. @@ -597,7 +599,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.