Browse code

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

Kamailio Dev authored on 29/03/2021 13:31:11
Showing 1 changed files
... ...
@@ -31,8 +31,9 @@ Richard Fuchs
31 31
 
32 32
               3.1. use_received (int)
33 33
               3.2. received_format (int)
34
-              3.3. enable_r2 (int)
35
-              3.4. sockname_mode (int)
34
+              3.3. received_name (str)
35
+              3.4. enable_r2 (int)
36
+              3.5. sockname_mode (int)
36 37
 
37 38
         4. Functions
38 39
 
... ...
@@ -48,14 +49,15 @@ Richard Fuchs
48 49
    1.1. Add Supported header
49 50
    1.2. Set use_received parameter
50 51
    1.3. Set received_format parameter
51
-   1.4. Set enable_r2 parameter
52
-   1.5. Set sockname_mode parameter
53
-   1.6. add_path usage
54
-   1.7. add_path(user) usage
55
-   1.8. add_path(user, parameters) usage
56
-   1.9. add_path_received() usage
57
-   1.10. add_path_received(user) usage
58
-   1.11. add_path_received(user, parameters) usage
52
+   1.4. Set received_name parameter
53
+   1.5. Set enable_r2 parameter
54
+   1.6. Set sockname_mode parameter
55
+   1.7. add_path usage
56
+   1.8. add_path(user) usage
57
+   1.9. add_path(user, parameters) usage
58
+   1.10. add_path_received() usage
59
+   1.11. add_path_received(user) usage
60
+   1.12. add_path_received(user, parameters) usage
59 61
 
60 62
 Chapter 1. Admin Guide
61 63
 
... ...
@@ -75,8 +77,9 @@ Chapter 1. Admin Guide
75 77
 
76 78
         3.1. use_received (int)
77 79
         3.2. received_format (int)
78
-        3.3. enable_r2 (int)
79
-        3.4. sockname_mode (int)
80
+        3.3. received_name (str)
81
+        3.4. enable_r2 (int)
82
+        3.5. sockname_mode (int)
80 83
 
81 84
    4. Functions
82 85
 
... ...
@@ -162,8 +165,9 @@ append_hf("Supported: path\r\n");
162 165
 
163 166
    3.1. use_received (int)
164 167
    3.2. received_format (int)
165
-   3.3. enable_r2 (int)
166
-   3.4. sockname_mode (int)
168
+   3.3. received_name (str)
169
+   3.4. enable_r2 (int)
170
+   3.5. sockname_mode (int)
167 171
 
168 172
 3.1. use_received (int)
169 173
 
... ...
@@ -195,7 +199,18 @@ modparam("path", "use_received", 1)
195 199
 modparam("path", "received_format", 1)
196 200
 ...
197 201
 
198
-3.3. enable_r2 (int)
202
+3.3. received_name (str)
203
+
204
+   Set the name of the header parameter to add the “received” value.
205
+
206
+   Default value is "received".
207
+
208
+   Example 1.4. Set received_name parameter
209
+...
210
+modparam("path", "received_name", "rcv")
211
+...
212
+
213
+3.4. enable_r2 (int)
199 214
 
200 215
    If set to 1, the module will add two Path headers, similar to the
201 216
    double Record-Route done by rr module. One Path headers corresponds to
... ...
@@ -210,19 +225,19 @@ modparam("path", "received_format", 1)
210 225
 
211 226
    Default value is 0.
212 227
 
213
-   Example 1.4. Set enable_r2 parameter
228
+   Example 1.5. Set enable_r2 parameter
214 229
 ...
215 230
 modparam("path", "enable_r2", 1)
216 231
 ...
217 232
 
218
-3.4. sockname_mode (int)
233
+3.5. sockname_mode (int)
219 234
 
220 235
    If set to 1, the Path URI is built to contain socket name in 'sn'
221 236
    parameter.
222 237
 
223 238
    Default value is 0.
224 239
 
225
-   Example 1.5. Set sockname_mode parameter
240
+   Example 1.6. Set sockname_mode parameter
226 241
 ...
227 242
 modparam("path", "sockname_mode", 1)
228 243
 ...
... ...
@@ -251,7 +266,7 @@ modparam("path", "sockname_mode", 1)
251 266
 
252 267
    This function can be used from REQUEST_ROUTE.
253 268
 
254
-   Example 1.6. add_path usage
269
+   Example 1.7. add_path usage
255 270
 ...
256 271
 if (!add_path()) {
257 272
         sl_send_reply("503", "Internal Path Error");
... ...
@@ -269,7 +284,7 @@ if (!add_path()) {
269 284
 
270 285
    This function can be used from REQUEST_ROUTE.
271 286
 
272
-   Example 1.7. add_path(user) usage
287
+   Example 1.8. add_path(user) usage
273 288
 ...
274 289
 if (!add_path("loadbalancer")) {
275 290
         sl_send_reply("503", "Internal Path Error");
... ...
@@ -291,7 +306,7 @@ if (!add_path("loadbalancer")) {
291 306
 
292 307
    This function can be used from REQUEST_ROUTE.
293 308
 
294
-   Example 1.8. add_path(user, parameters) usage
309
+   Example 1.9. add_path(user, parameters) usage
295 310
 ...
296 311
 if (!add_path("loadbalancer", "ob")) {
297 312
         sl_send_reply("503", "Internal Path Error");
... ...
@@ -315,7 +330,7 @@ if (!add_path("loadbalancer", "ob")) {
315 330
 
316 331
    This function can be used from REQUEST_ROUTE.
317 332
 
318
-   Example 1.9. add_path_received() usage
333
+   Example 1.10. add_path_received() usage
319 334
 ...
320 335
 if (!add_path_received()) {
321 336
         sl_send_reply("503", "Internal Path Error");
... ...
@@ -332,7 +347,7 @@ if (!add_path_received()) {
332 347
 
333 348
    This function can be used from REQUEST_ROUTE.
334 349
 
335
-   Example 1.10. add_path_received(user) usage
350
+   Example 1.11. add_path_received(user) usage
336 351
 ...
337 352
 if (!add_path_received("inbound")) {
338 353
         sl_send_reply("503", "Internal Path Error");
... ...
@@ -349,7 +364,7 @@ if (!add_path_received("inbound")) {
349 364
 
350 365
    This function can be used from REQUEST_ROUTE.
351 366
 
352
-   Example 1.11. add_path_received(user, parameters) usage
367
+   Example 1.12. add_path_received(user, parameters) usage
353 368
 ...
354 369
 if (!add_path_received("inbound", "ob")) {
355 370
         sl_send_reply("503", "Internal Path Error");