[sr-dev] git:master:5affee3b: modules: readme files regenerated - tsilo ... [skip ci]

Module: kamailio Branch: master Commit: 5affee3bcbf5b4a4cad5acfee1c24c0def1ad58c URL: https://github.com/kamailio/kamailio/commit/5affee3bcbf5b4a4cad5acfee1c24c0… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2021-11-19T09:31:15+01:00 modules: readme files regenerated - tsilo ... [skip ci] --- Modified: src/modules/tsilo/README --- Diff: https://github.com/kamailio/kamailio/commit/5affee3bcbf5b4a4cad5acfee1c24c0… Patch: https://github.com/kamailio/kamailio/commit/5affee3bcbf5b4a4cad5acfee1c24c0… --- diff --git a/src/modules/tsilo/README b/src/modules/tsilo/README index 47c14ce1bb..c93fa0ebef 100644 --- a/src/modules/tsilo/README +++ b/src/modules/tsilo/README @@ -10,6 +10,10 @@ Federico Cabiddu <federico.cabiddu(a)gmail.com> +Donat Zenichev + + <dzenichev(a)sipwise.com> + Copyright © 2015 Federico Cabiddu __________________________________________________________________ @@ -32,7 +36,8 @@ Federico Cabiddu 4.1. ts_store([uri]) 4.2. ts_append(domain, ruri) - 4.3. ts_append_to(tindex, tlabel, domain, [uri]) + 4.3. ts_append_by_contact(domain, ruri [, contact]) + 4.4. ts_append_to(tindex, tlabel, domain, [uri]) 5. RPC Commands @@ -53,7 +58,8 @@ Federico Cabiddu 1.2. Set use_domain parameter 1.3. ts_store usage 1.4. ts_append usage - 1.5. ts_append_to usage + 1.5. ts_append_by_contact usage + 1.6. ts_append_to usage Chapter 1. Admin Guide @@ -74,7 +80,8 @@ Chapter 1. Admin Guide 4.1. ts_store([uri]) 4.2. ts_append(domain, ruri) - 4.3. ts_append_to(tindex, tlabel, domain, [uri]) + 4.3. ts_append_by_contact(domain, ruri [, contact]) + 4.4. ts_append_to(tindex, tlabel, domain, [uri]) 5. RPC Commands @@ -157,7 +164,8 @@ modparam("tsilo", "use_domain", 1) 4.1. ts_store([uri]) 4.2. ts_append(domain, ruri) - 4.3. ts_append_to(tindex, tlabel, domain, [uri]) + 4.3. ts_append_by_contact(domain, ruri [, contact]) + 4.4. ts_append_to(tindex, tlabel, domain, [uri]) 4.1. ts_store([uri]) @@ -200,7 +208,40 @@ if (is_method("REGISTER")) { } ... -4.3. ts_append_to(tindex, tlabel, domain, [uri]) +4.3. ts_append_by_contact(domain, ruri [, contact]) + + Has almost the same intention as the ts_append(), but gives a + possibility to append branches only for a specific location record + (Contact URI). The contact's URI value can be either taken from the + currently processed REGISTER or (optionally) given as a third + parameter. If the Contact URI for a lookup is given as the parameter, + it is possible to provide it as a pseudo-variable. The contact lookup + is performed on the table specified by the domain parameter. The method + should be called when a REGISTER request is received. + + Meaning of the parameters is as follows: + * domain - Name of table that should be used for looking up new + contacts for r-uri. + * ruri - The r-uri for which we want to check existing transactions + and add them new branches. Can be a static string value or a + dynamic string with pseudo-variables. + * contact - Optional, a value of the location record (contact URI) + based on which to perform the branch appending. If not given, the + value will be taken from the currently processed REGISTER. If a + location lookup based on this Contact URI fails (no location record + found), then the branch append will not happen. + + This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. + + Example 1.5. ts_append_by_contact usage +... +if (is_method("REGISTER")) { + $var(formated_ct) = $(x_hdr(Contact){nameaddr.uri}); + ts_append_by_contact("location", "$tu", "$var(formated_ct)"); +} +... + +4.4. ts_append_to(tindex, tlabel, domain, [uri]) The method add branches to the transaction identified by tindex and tlabel, performing a contacts lookup on the table specified by the @@ -218,7 +259,7 @@ if (is_method("REGISTER")) { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.5. ts_append_to usage + Example 1.6. ts_append_to usage ... if (is_method("REGISTER")) { $var(tindex) = ...