Browse code

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

Kamailio Dev authored on 19/11/2021 08:31:15
Showing 1 changed files
... ...
@@ -10,6 +10,10 @@ Federico Cabiddu
10 10
 
11 11
    <federico.cabiddu@gmail.com>
12 12
 
13
+Donat Zenichev
14
+
15
+   <dzenichev@sipwise.com>
16
+
13 17
    Copyright © 2015 Federico Cabiddu
14 18
      __________________________________________________________________
15 19
 
... ...
@@ -32,7 +36,8 @@ Federico Cabiddu
32 36
 
33 37
               4.1. ts_store([uri])
34 38
               4.2. ts_append(domain, ruri)
35
-              4.3. ts_append_to(tindex, tlabel, domain, [uri])
39
+              4.3. ts_append_by_contact(domain, ruri [, contact])
40
+              4.4. ts_append_to(tindex, tlabel, domain, [uri])
36 41
 
37 42
         5. RPC Commands
38 43
 
... ...
@@ -53,7 +58,8 @@ Federico Cabiddu
53 58
    1.2. Set use_domain parameter
54 59
    1.3. ts_store usage
55 60
    1.4. ts_append usage
56
-   1.5. ts_append_to usage
61
+   1.5. ts_append_by_contact usage
62
+   1.6. ts_append_to usage
57 63
 
58 64
 Chapter 1. Admin Guide
59 65
 
... ...
@@ -74,7 +80,8 @@ Chapter 1. Admin Guide
74 80
 
75 81
         4.1. ts_store([uri])
76 82
         4.2. ts_append(domain, ruri)
77
-        4.3. ts_append_to(tindex, tlabel, domain, [uri])
83
+        4.3. ts_append_by_contact(domain, ruri [, contact])
84
+        4.4. ts_append_to(tindex, tlabel, domain, [uri])
78 85
 
79 86
    5. RPC Commands
80 87
 
... ...
@@ -157,7 +164,8 @@ modparam("tsilo", "use_domain", 1)
157 164
 
158 165
    4.1. ts_store([uri])
159 166
    4.2. ts_append(domain, ruri)
160
-   4.3. ts_append_to(tindex, tlabel, domain, [uri])
167
+   4.3. ts_append_by_contact(domain, ruri [, contact])
168
+   4.4. ts_append_to(tindex, tlabel, domain, [uri])
161 169
 
162 170
 4.1. ts_store([uri])
163 171
 
... ...
@@ -200,7 +208,40 @@ if (is_method("REGISTER")) {
200 208
 }
201 209
 ...
202 210
 
203
-4.3. ts_append_to(tindex, tlabel, domain, [uri])
211
+4.3. ts_append_by_contact(domain, ruri [, contact])
212
+
213
+   Has almost the same intention as the ts_append(), but gives a
214
+   possibility to append branches only for a specific location record
215
+   (Contact URI). The contact's URI value can be either taken from the
216
+   currently processed REGISTER or (optionally) given as a third
217
+   parameter. If the Contact URI for a lookup is given as the parameter,
218
+   it is possible to provide it as a pseudo-variable. The contact lookup
219
+   is performed on the table specified by the domain parameter. The method
220
+   should be called when a REGISTER request is received.
221
+
222
+   Meaning of the parameters is as follows:
223
+     * domain - Name of table that should be used for looking up new
224
+       contacts for r-uri.
225
+     * ruri - The r-uri for which we want to check existing transactions
226
+       and add them new branches. Can be a static string value or a
227
+       dynamic string with pseudo-variables.
228
+     * contact - Optional, a value of the location record (contact URI)
229
+       based on which to perform the branch appending. If not given, the
230
+       value will be taken from the currently processed REGISTER. If a
231
+       location lookup based on this Contact URI fails (no location record
232
+       found), then the branch append will not happen.
233
+
234
+   This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
235
+
236
+   Example 1.5. ts_append_by_contact usage
237
+...
238
+if (is_method("REGISTER")) {
239
+        $var(formated_ct) = $(x_hdr(Contact){nameaddr.uri});
240
+        ts_append_by_contact("location", "$tu", "$var(formated_ct)");
241
+}
242
+...
243
+
244
+4.4. ts_append_to(tindex, tlabel, domain, [uri])
204 245
 
205 246
    The method add branches to the transaction identified by tindex and
206 247
    tlabel, performing a contacts lookup on the table specified by the
... ...
@@ -218,7 +259,7 @@ if (is_method("REGISTER")) {
218 259
 
219 260
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
220 261
 
221
-   Example 1.5. ts_append_to usage
262
+   Example 1.6. ts_append_to usage
222 263
 ...
223 264
 if (is_method("REGISTER")) {
224 265
         $var(tindex) = ...