Skip to content

Commit

Permalink
modules: readme files regenerated - path ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@kamailio-dev
kamailio-dev committed Apr 2, 2020
1 parent 9a35ca7 commit bfe4863
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 34 deletions.
42 changes: 28 additions & 14 deletions src/modules/path/README
View file
Expand Up @@ -8,8 +8,6 @@ Edited by

Andreas Granig

Edited by

Richard Fuchs

Copyright © 2006 Inode GmbH
Expand All @@ -34,6 +32,7 @@ Richard Fuchs
3.1. use_received (int)
3.2. received_format (int)
3.3. enable_r2 (int)
3.4. sockname_mode (int)

4. Functions

Expand All @@ -50,12 +49,13 @@ Richard Fuchs
1.2. Set use_received parameter
1.3. Set received_format parameter
1.4. Set enable_r2 parameter
1.5. add_path usage
1.6. add_path(user) usage
1.7. add_path(user, parameters) usage
1.8. add_path_received() usage
1.9. add_path_received(user) usage
1.10. add_path_received(user, parameters) usage
1.5. Set sockname_mode parameter
1.6. add_path usage
1.7. add_path(user) usage
1.8. add_path(user, parameters) usage
1.9. add_path_received() usage
1.10. add_path_received(user) usage
1.11. add_path_received(user, parameters) usage

Chapter 1. Admin Guide

Expand All @@ -76,6 +76,7 @@ Chapter 1. Admin Guide
3.1. use_received (int)
3.2. received_format (int)
3.3. enable_r2 (int)
3.4. sockname_mode (int)

4. Functions

Expand Down Expand Up @@ -162,6 +163,7 @@ append_hf("Supported: path\r\n");
3.1. use_received (int)
3.2. received_format (int)
3.3. enable_r2 (int)
3.4. sockname_mode (int)

3.1. use_received (int)

Expand Down Expand Up @@ -213,6 +215,18 @@ modparam("path", "received_format", 1)
modparam("path", "enable_r2", 1)
...

3.4. sockname_mode (int)

If set to 1, the Path URI is built to contain socket name in 'sn'
parameter.

Default value is 0.

Example 1.5. Set sockname_mode parameter
...
modparam("path", "sockname_mode", 1)
...

4. Functions

4.1. add_path()
Expand All @@ -237,7 +251,7 @@ modparam("path", "enable_r2", 1)

This function can be used from REQUEST_ROUTE.

Example 1.5. add_path usage
Example 1.6. add_path usage
...
if (!add_path()) {
sl_send_reply("503", "Internal Path Error");
Expand All @@ -255,7 +269,7 @@ if (!add_path()) {

This function can be used from REQUEST_ROUTE.

Example 1.6. add_path(user) usage
Example 1.7. add_path(user) usage
...
if (!add_path("loadbalancer")) {
sl_send_reply("503", "Internal Path Error");
Expand All @@ -277,7 +291,7 @@ if (!add_path("loadbalancer")) {

This function can be used from REQUEST_ROUTE.

Example 1.7. add_path(user, parameters) usage
Example 1.8. add_path(user, parameters) usage
...
if (!add_path("loadbalancer", "ob")) {
sl_send_reply("503", "Internal Path Error");
Expand All @@ -301,7 +315,7 @@ if (!add_path("loadbalancer", "ob")) {

This function can be used from REQUEST_ROUTE.

Example 1.8. add_path_received() usage
Example 1.9. add_path_received() usage
...
if (!add_path_received()) {
sl_send_reply("503", "Internal Path Error");
Expand All @@ -318,7 +332,7 @@ if (!add_path_received()) {

This function can be used from REQUEST_ROUTE.

Example 1.9. add_path_received(user) usage
Example 1.10. add_path_received(user) usage
...
if (!add_path_received("inbound")) {
sl_send_reply("503", "Internal Path Error");
Expand All @@ -335,7 +349,7 @@ if (!add_path_received("inbound")) {

This function can be used from REQUEST_ROUTE.

Example 1.10. add_path_received(user, parameters) usage
Example 1.11. add_path_received(user, parameters) usage
...
if (!add_path_received("inbound", "ob")) {
sl_send_reply("503", "Internal Path Error");
Expand Down
56 changes: 36 additions & 20 deletions src/modules/rr/README
View file
Expand Up @@ -46,6 +46,7 @@ Bogdan-Andrei Iancu
4.6. custom_user_avp (avp string)
4.7. force_send_socket (int)
4.8. ignore_sips (int)
4.9. sockname_mode (int)

5. Functions

Expand Down Expand Up @@ -89,16 +90,17 @@ Bogdan-Andrei Iancu
1.8. custom_user_avp usage
1.9. Set force_send_socket parameter
1.10. Set ignore_sips parameter
1.11. loose_route usage
1.12. record_route usage
1.13. remove_record_route usage
1.14. record_route_preset usage
1.15. record_route_advertised_address usage
1.16. add_rr_param usage
1.17. check_route_param usage
1.18. is_direction usage
1.19. rr_next_hop_route usage
1.20. $route_uri
1.11. Set sockname_mode parameter
1.12. loose_route usage
1.13. record_route usage
1.14. remove_record_route usage
1.15. record_route_preset usage
1.16. record_route_advertised_address usage
1.17. add_rr_param usage
1.18. check_route_param usage
1.19. is_direction usage
1.20. rr_next_hop_route usage
1.21. $route_uri
2.1. record_route usage
2.2. record_route_advertised_address usage
2.3. Loading RR module's API from another module
Expand All @@ -124,6 +126,7 @@ Chapter 1. Admin Guide
4.6. custom_user_avp (avp string)
4.7. force_send_socket (int)
4.8. ignore_sips (int)
4.9. sockname_mode (int)

5. Functions

Expand Down Expand Up @@ -220,6 +223,7 @@ UAC Kamailio PROXY UAS
4.6. custom_user_avp (avp string)
4.7. force_send_socket (int)
4.8. ignore_sips (int)
4.9. sockname_mode (int)

4.1. enable_full_lr (integer)

Expand Down Expand Up @@ -360,6 +364,18 @@ modparam("rr", "force_send_socket", 1)
modparam("rr", "ignore_sips", 1)
...

4.9. sockname_mode (int)

If set to 1, the Record-Route URI is built to contain socket name in
'sn' parameter.

Default value is 0.

Example 1.11. Set sockname_mode parameter
...
modparam("rr", "sockname_mode", 1)
...

5. Functions

5.1. loose_route()
Expand Down Expand Up @@ -414,7 +430,7 @@ modparam("rr", "ignore_sips", 1)

This function can be used from REQUEST_ROUTE.

Example 1.11. loose_route usage
Example 1.12. loose_route usage
...
loose_route();
...
Expand All @@ -441,7 +457,7 @@ loose_route();
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
FAILURE_ROUTE.

Example 1.12. record_route usage
Example 1.13. record_route usage
...
record_route();
...
Expand All @@ -455,7 +471,7 @@ record_route();

This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.

Example 1.13. remove_record_route usage
Example 1.14. remove_record_route usage
...
remove_record_route();
...
Expand Down Expand Up @@ -483,7 +499,7 @@ remove_record_route();
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
FAILURE_ROUTE.

Example 1.14. record_route_preset usage
Example 1.15. record_route_preset usage
...
record_route_preset("1.2.3.4:5090");
...
Expand All @@ -510,7 +526,7 @@ record_route_preset("1.2.3.4:5090");
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
FAILURE_ROUTE.

Example 1.15. record_route_advertised_address usage
Example 1.16. record_route_advertised_address usage
...
record_route_advertised_address("1.2.3.4:5080");
...
Expand All @@ -529,7 +545,7 @@ record_route_advertised_address("1.2.3.4:5080");
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
FAILURE_ROUTE.

Example 1.16. add_rr_param usage
Example 1.17. add_rr_param usage
...
add_rr_param(";nat=yes");
...
Expand All @@ -545,7 +561,7 @@ add_rr_param(";nat=yes");

This function can be used from REQUEST_ROUTE.

Example 1.17. check_route_param usage
Example 1.18. check_route_param usage
...
if (check_route_param("nat=yes")) {
setflag(6);
Expand All @@ -572,7 +588,7 @@ if (check_route_param("nat=yes")) {

This function can be used from REQUEST_ROUTE.

Example 1.18. is_direction usage
Example 1.19. is_direction usage
...
if (is_direction("downstream")) {
xdbg("in-dialog request from caller to callee (downstream) ($rm)\n");
Expand All @@ -589,7 +605,7 @@ if (is_direction("downstream")) {

This function can be used from ANY_ROUTE.

Example 1.19. rr_next_hop_route usage
Example 1.20. rr_next_hop_route usage
...
if(loose_route) {
if(rr_next_hop_route()) {
Expand All @@ -607,7 +623,7 @@ if(loose_route) {

Returns the URI of the top route-header.

Example 1.20. $route_uri
Example 1.21. $route_uri
...
xdbg("Route-URI is: $route_uri\n");
...
Expand Down

0 comments on commit bfe4863

Please sign in to comment.