Module: kamailio Branch: master Commit: 62e2c61f29afda6256601468deebd604b8567d54 URL: https://github.com/kamailio/kamailio/commit/62e2c61f29afda6256601468deebd604b8567d54
Author: Kamailio Dev <[email protected]> Committer: Kamailio Dev <[email protected]> Date: 2026-07-01T09:01:11+02:00 modules: readme files regenerated - path ... [skip ci] --- Modified: src/modules/path/README --- Diff: https://github.com/kamailio/kamailio/commit/62e2c61f29afda6256601468deebd604b8567d54.diff Patch: https://github.com/kamailio/kamailio/commit/62e2c61f29afda6256601468deebd604b8567d54.patch --- diff --git a/src/modules/path/README b/src/modules/path/README index 3574ec9d33e..e36865e3306 100644 --- a/src/modules/path/README +++ b/src/modules/path/README @@ -43,6 +43,11 @@ Richard Fuchs 4.4. add_path_received() 4.5. add_path_received(user) 4.6. add_path_received(user, parameters) + 4.7. add_path_advertised_address(address [, user [, + parameters]]) + + 4.8. add_path_received_advertised_address(address [, user [, + parameters]]) List of Examples @@ -58,6 +63,8 @@ Richard Fuchs 1.10. add_path_received() usage 1.11. add_path_received(user) usage 1.12. add_path_received(user, parameters) usage + 1.13. add_path_advertised_address usage + 1.14. add_path_received_advertised_address usage Chapter 1. Admin Guide @@ -89,6 +96,9 @@ Chapter 1. Admin Guide 4.4. add_path_received() 4.5. add_path_received(user) 4.6. add_path_received(user, parameters) + 4.7. add_path_advertised_address(address [, user [, parameters]]) + 4.8. add_path_received_advertised_address(address [, user [, + parameters]]) 1. Overview @@ -250,6 +260,9 @@ modparam("path", "sockname_mode", 1) 4.4. add_path_received() 4.5. add_path_received(user) 4.6. add_path_received(user, parameters) + 4.7. add_path_advertised_address(address [, user [, parameters]]) + 4.8. add_path_received_advertised_address(address [, user [, + parameters]]) 4.1. add_path() @@ -371,3 +384,62 @@ if (!add_path_received("inbound", "ob")) { ... }; ... + +4.7. add_path_advertised_address(address [, user [, parameters]]) + + This function behaves like add_path(), add_path(user) or add_path(user, + parameters) depending on the number of arguments given, with one + difference: the host part of the Path URI is built from the given + address instead of the outgoing socket address (no socket/lump + substitution is applied). + + Meaning of the parameters is as follows: + * address - The host (and optional port) used as domain part of the + Path URI, e.g. âproxy.example.comâ or â1.2.3.4:5080â. SPVE is + supported. + * user - The username to be inserted as user part. SPVE is supported. + Optional. + * parameters - Additional parameters appended to the Path URI. SPVE + is supported. Optional. + + This function can be used from REQUEST_ROUTE. + + Example 1.13. add_path_advertised_address usage +... +if (!add_path_advertised_address("proxy.example.com")) { + sl_send_reply("503", "Internal Path Error"); + ... +}; +# with user and parameters +add_path_advertised_address("1.2.3.4:5080", "inbound", "ob"); +... + +4.8. add_path_received_advertised_address(address [, user [, parameters]]) + + This function behaves like add_path_received(), add_path_received(user) + or add_path_received(user, parameters) depending on the number of + arguments given, with one difference: the host part of the Path URI is + built from the given address instead of the outgoing socket address (no + socket/lump substitution is applied). The address the request was + received from is still appended as received-parameter. + + Meaning of the parameters is as follows: + * address - The host (and optional port) used as domain part of the + Path URI, e.g. âproxy.example.comâ or â1.2.3.4:5080â. SPVE is + supported. + * user - The username to be inserted as user part. SPVE is supported. + Optional. + * parameters - Additional parameters appended to the Path URI. SPVE + is supported. Optional. + + This function can be used from REQUEST_ROUTE. + + Example 1.14. add_path_received_advertised_address usage +... +if (!add_path_received_advertised_address("proxy.example.com")) { + sl_send_reply("503", "Internal Path Error"); + ... +}; +# with user and parameters +add_path_received_advertised_address("1.2.3.4:5080", "inbound", "ob"); +...
_______________________________________________ Kamailio - Development Mailing List -- [email protected] To unsubscribe send an email to [email protected] Important: keep the mailing list in the recipients, do not reply only to the sender!
