From 18c5ca1daecb922f4df371065d489503b70a981c Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Fri, 3 Mar 2017 09:46:21 +0100 Subject: [PATCH] modules: readme files regenerated - siputils ... [skip ci] --- src/modules/siputils/README | 213 ++++++++++++++++++++---------------- 1 file changed, 116 insertions(+), 97 deletions(-) diff --git a/src/modules/siputils/README b/src/modules/siputils/README index 72d6a0ff59a..e7e5b7985e0 100644 --- a/src/modules/siputils/README +++ b/src/modules/siputils/README @@ -82,22 +82,23 @@ Gabriel Vasile 4.12. is_tel_number(tval) 4.13. is_numeric(tval) 4.14. is_alphanum(tval) - 4.15. encode_contact(encoding_prefix,hostpart) - 4.16. decode_contact() - 4.17. decode_contact_header() - 4.18. cmp_uri(str1, str2) - 4.19. cmp_aor(str1, str2) - 4.20. append_rpid_hf() - 4.21. append_rpid_hf(prefix, suffix) - 4.22. is_rpid_user_e164() - 4.23. set_uri_user(uri, user) - 4.24. set_uri_host(uri, host) - 4.25. is_request() - 4.26. is_reply() - 4.27. is_gruu([uri]) - 4.28. is_supported(option) - 4.29. is_first_hop() - 4.30. sip_p_charging_vector(flags) + 4.15. is_alphanumex(tval, eset) + 4.16. encode_contact(encoding_prefix,hostpart) + 4.17. decode_contact() + 4.18. decode_contact_header() + 4.19. cmp_uri(str1, str2) + 4.20. cmp_aor(str1, str2) + 4.21. append_rpid_hf() + 4.22. append_rpid_hf(prefix, suffix) + 4.23. is_rpid_user_e164() + 4.24. set_uri_user(uri, user) + 4.25. set_uri_host(uri, host) + 4.26. is_request() + 4.27. is_reply() + 4.28. is_gruu([uri]) + 4.29. is_supported(option) + 4.30. is_first_hop() + 4.31. sip_p_charging_vector(flags) 5. Exported pseudo-variables @@ -132,22 +133,23 @@ Gabriel Vasile 1.21. is_tel_number usage 1.22. is_numeric usage 1.23. is_alphanum usage - 1.24. encode_contact usage - 1.25. decode_contact usage - 1.26. decode_contact_header usage - 1.27. cmp_uri usage - 1.28. cmp_aor usage - 1.29. append_rpid_hf usage - 1.30. append_rpid_hf(prefix, suffix) usage - 1.31. is_rpid_user_e164 usage - 1.32. set_uri_user usage - 1.33. set_uri_host usage - 1.34. is_request usage - 1.35. is_reply usage - 1.36. is_gruu() usage - 1.37. is_supported() usage - 1.38. is_first_hop() usage - 1.39. sip_p_charging_vector() usage + 1.24. is_alphanumex usage + 1.25. encode_contact usage + 1.26. decode_contact usage + 1.27. decode_contact_header usage + 1.28. cmp_uri usage + 1.29. cmp_aor usage + 1.30. append_rpid_hf usage + 1.31. append_rpid_hf(prefix, suffix) usage + 1.32. is_rpid_user_e164 usage + 1.33. set_uri_user usage + 1.34. set_uri_host usage + 1.35. is_request usage + 1.36. is_reply usage + 1.37. is_gruu() usage + 1.38. is_supported() usage + 1.39. is_first_hop() usage + 1.40. sip_p_charging_vector() usage Chapter 1. Admin Guide @@ -187,22 +189,23 @@ Chapter 1. Admin Guide 4.12. is_tel_number(tval) 4.13. is_numeric(tval) 4.14. is_alphanum(tval) - 4.15. encode_contact(encoding_prefix,hostpart) - 4.16. decode_contact() - 4.17. decode_contact_header() - 4.18. cmp_uri(str1, str2) - 4.19. cmp_aor(str1, str2) - 4.20. append_rpid_hf() - 4.21. append_rpid_hf(prefix, suffix) - 4.22. is_rpid_user_e164() - 4.23. set_uri_user(uri, user) - 4.24. set_uri_host(uri, host) - 4.25. is_request() - 4.26. is_reply() - 4.27. is_gruu([uri]) - 4.28. is_supported(option) - 4.29. is_first_hop() - 4.30. sip_p_charging_vector(flags) + 4.15. is_alphanumex(tval, eset) + 4.16. encode_contact(encoding_prefix,hostpart) + 4.17. decode_contact() + 4.18. decode_contact_header() + 4.19. cmp_uri(str1, str2) + 4.20. cmp_aor(str1, str2) + 4.21. append_rpid_hf() + 4.22. append_rpid_hf(prefix, suffix) + 4.23. is_rpid_user_e164() + 4.24. set_uri_user(uri, user) + 4.25. set_uri_host(uri, host) + 4.26. is_request() + 4.27. is_reply() + 4.28. is_gruu([uri]) + 4.29. is_supported(option) + 4.30. is_first_hop() + 4.31. sip_p_charging_vector(flags) 5. Exported pseudo-variables @@ -400,22 +403,23 @@ modparam("auth", "rpid_avp", "$avp(myrpid)") 4.12. is_tel_number(tval) 4.13. is_numeric(tval) 4.14. is_alphanum(tval) - 4.15. encode_contact(encoding_prefix,hostpart) - 4.16. decode_contact() - 4.17. decode_contact_header() - 4.18. cmp_uri(str1, str2) - 4.19. cmp_aor(str1, str2) - 4.20. append_rpid_hf() - 4.21. append_rpid_hf(prefix, suffix) - 4.22. is_rpid_user_e164() - 4.23. set_uri_user(uri, user) - 4.24. set_uri_host(uri, host) - 4.25. is_request() - 4.26. is_reply() - 4.27. is_gruu([uri]) - 4.28. is_supported(option) - 4.29. is_first_hop() - 4.30. sip_p_charging_vector(flags) + 4.15. is_alphanumex(tval, eset) + 4.16. encode_contact(encoding_prefix,hostpart) + 4.17. decode_contact() + 4.18. decode_contact_header() + 4.19. cmp_uri(str1, str2) + 4.20. cmp_aor(str1, str2) + 4.21. append_rpid_hf() + 4.22. append_rpid_hf(prefix, suffix) + 4.23. is_rpid_user_e164() + 4.24. set_uri_user(uri, user) + 4.25. set_uri_host(uri, host) + 4.26. is_request() + 4.27. is_reply() + 4.28. is_gruu([uri]) + 4.29. is_supported(option) + 4.30. is_first_hop() + 4.31. sip_p_charging_vector(flags) 4.1. ring_insert_callid() @@ -665,7 +669,22 @@ if (is_alphanum("$rU")) { } ... -4.15. encode_contact(encoding_prefix,hostpart) +4.15. is_alphanumex(tval, eset) + + Checks if the value of parameter 'tval' consists solely of decimal + digits, alphabetic ASCII characters and the characters in the second + parameter 'eset'. The parameters can include variables. + + This function can be used from ANY_ROUTE. + + Example 1.24. is_alphanumex usage +... +if (is_alphanumex("$rU", "+.-_")) { + ... +} +... + +4.16. encode_contact(encoding_prefix,hostpart) This function will encode uri-s inside Contact header in the following manner sip:username:password@ip:port;transport=protocol goes @@ -687,12 +706,12 @@ if (is_alphanum("$rU")) { This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE. - Example 1.24. encode_contact usage + Example 1.25. encode_contact usage ... if (src_ip == 10.0.0.0/8) encode_contact("natted_client","1.2.3.4"); ... -4.16. decode_contact() +4.17. decode_contact() This function will decode the request URI. If the RURI is in the format sip:encoding_prefix*username*ip*port*protocol@hostpart it will be @@ -705,12 +724,12 @@ if (src_ip == 10.0.0.0/8) encode_contact("natted_client","1.2.3.4"); This function can be used from REQUEST_ROUTE. - Example 1.25. decode_contact usage + Example 1.26. decode_contact usage ... if (uri =~ "^sip:natted_client") { decode_contact(); } ... -4.17. decode_contact_header() +4.18. decode_contact_header() This function will decode URIs inside Contact header. If the URI in the format sip:encoding_prefix*username*ip*port*protocol@hostpart it will @@ -723,7 +742,7 @@ if (uri =~ "^sip:natted_client") { decode_contact(); } This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE. - Example 1.26. decode_contact_header usage + Example 1.27. decode_contact_header usage ... reply_route[2] { ... @@ -732,13 +751,13 @@ reply_route[2] { } ... -4.18. cmp_uri(str1, str2) +4.19. cmp_uri(str1, str2) The function returns true if the two parameters matches as SIP URI. This function can be used from ANY_ROUTE. - Example 1.27. cmp_uri usage + Example 1.28. cmp_uri usage ... if(cmp_uri("$ru", "sip:kamailio@kamailio.org")) { @@ -746,14 +765,14 @@ if(cmp_uri("$ru", "sip:kamailio@kamailio.org")) } ... -4.19. cmp_aor(str1, str2) +4.20. cmp_aor(str1, str2) The function returns true if the two parameters matches as AoR. The parameters have to be SIP URIs. This function can be used from ANY_ROUTE. - Example 1.28. cmp_aor usage + Example 1.29. cmp_aor usage ... if(cmp_aor("$rU@KaMaIlIo.org", "sip:kamailio@$fd")) { @@ -761,7 +780,7 @@ if(cmp_aor("$rU@KaMaIlIo.org", "sip:kamailio@$fd")) } ... -4.20. append_rpid_hf() +4.21. append_rpid_hf() Appends to the message a Remote-Party-ID header that contains header 'Remote-Party-ID: ' followed by the saved value of the SIP URI received @@ -772,14 +791,14 @@ if(cmp_aor("$rU@KaMaIlIo.org", "sip:kamailio@$fd")) This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE. - Example 1.29. append_rpid_hf usage + Example 1.30. append_rpid_hf usage ... append_rpid_hf(); # Append Remote-Party-ID header field ... -4.21. append_rpid_hf(prefix, suffix) +4.22. append_rpid_hf(prefix, suffix) - This function is the same as Section 4.20, “ append_rpid_hf()”. The + This function is the same as Section 4.21, “ append_rpid_hf()”. The only difference is that it accepts two parameters--prefix and suffix to be added to Remote-Party-ID header field. This function ignores rpid_prefix and rpid_suffix parameters, instead of that allows to set @@ -796,13 +815,13 @@ append_rpid_hf(); # Append Remote-Party-ID header field This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE. - Example 1.30. append_rpid_hf(prefix, suffix) usage + Example 1.31. append_rpid_hf(prefix, suffix) usage ... # Append Remote-Party-ID header field append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes"); ... -4.22. is_rpid_user_e164() +4.23. is_rpid_user_e164() The function checks if the SIP URI received from the database or radius server and will potentially be used in Remote-Party-ID header field @@ -812,68 +831,68 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes"); This function can be used from REQUEST_ROUTE. - Example 1.31. is_rpid_user_e164 usage + Example 1.32. is_rpid_user_e164 usage ... if (is_rpid_user_e164()) { # do something here }; ... -4.23. set_uri_user(uri, user) +4.24. set_uri_user(uri, user) Sets userpart of SIP URI stored in writable pseudo variable 'uri' to value of pseudo variable 'user'. This function can be used from ANY_ROUTE. - Example 1.32. set_uri_user usage + Example 1.33. set_uri_user usage ... $var(uri) = "sip:user@host"; $var(user) = "new_user"; set_uri_user("$var(uri)", "$var(user)"); ... -4.24. set_uri_host(uri, host) +4.25. set_uri_host(uri, host) Sets hostpart of SIP URI stored in writable pseudo variable 'uri' to value of pseudo variable 'host'. This function can be used from ANY_ROUTE. - Example 1.33. set_uri_host usage + Example 1.34. set_uri_host usage ... $var(uri) = "sip:user@host"; $var(host) = "new_host"; set_uri_host("$var(uri)", "$var(host)"); ... -4.25. is_request() +4.26. is_request() Return true if the SIP message is a request. This function can be used from ANY_ROUTE. - Example 1.34. is_request usage + Example 1.35. is_request usage ... if (is_request()) { ... } ... -4.26. is_reply() +4.27. is_reply() Return true if the SIP message is a reply. This function can be used from ANY_ROUTE. - Example 1.35. is_reply usage + Example 1.36. is_reply usage ... if (is_reply()) { ... } ... -4.27. is_gruu([uri]) +4.28. is_gruu([uri]) The function returns true if the uri is GRUU ('gr' parameter is present): 1 - pub-gruu; 2 - temp-gruu. @@ -884,12 +903,12 @@ if (is_reply()) { This function can be used from ANY_ROUTE. - Example 1.36. is_gruu() usage + Example 1.37. is_gruu() usage ... if(is_gruu()) { ... } ... -4.28. is_supported(option) +4.29. is_supported(option) Function returns true if given option is listed in Supported header(s) (if any) of the request. Currently the following options are known: @@ -897,12 +916,12 @@ if(is_gruu()) { ... } This function can be used from ANY_ROUTE. - Example 1.37. is_supported() usage + Example 1.38. is_supported() usage ... if (is_supported("outbound")) { ... } ... -4.29. is_first_hop() +4.30. is_first_hop() The function returns true if the proxy is first hop after the original sender. For incoming SIP requests, it means there is only one Via @@ -914,19 +933,19 @@ if (is_supported("outbound")) { ... } This function can be used from ANY_ROUTE. - Example 1.38. is_first_hop() usage + Example 1.39. is_first_hop() usage ... if(is_first_hop()) { ... } ... -4.30. sip_p_charging_vector(flags) +4.31. sip_p_charging_vector(flags) Manage the P-Charging-Vector header (RFC7315). The flags can be: 'r' - remove; 'g' - generate; 'f' - force (remove + generate). This function can be used from ANY_ROUTE. - Example 1.39. sip_p_charging_vector() usage + Example 1.40. sip_p_charging_vector() usage ... sip_p_charging_vector("g"); ...