Browse code

dialog: readme built form docbook

Daniel-Constantin Mierla authored on 04/01/2015 23:05:22
Showing 1 changed files
... ...
@@ -92,6 +92,7 @@ Alex Balashov
92 92
               5.49. timeout_noreset (int)
93 93
               5.50. timer_procs (int)
94 94
               5.51. track_cseq_updates (int)
95
+              5.52. lreq_callee_headers (string)
95 96
 
96 97
         6. Functions
97 98
 
... ...
@@ -220,23 +221,24 @@ Alex Balashov
220 221
    1.49. Set timeout_noreset parameter
221 222
    1.50. Set timer_procs parameter
222 223
    1.51. Set track_cseq_updates parameter
223
-   1.52. set_dlg_profile usage
224
-   1.53. unset_dlg_profile usage
225
-   1.54. is_in_profile usage
226
-   1.55. get_profile_size usage
227
-   1.56. dlg_isflagset usage
228
-   1.57. dlg_setflag usage
229
-   1.58. dlg_resetflag usage
230
-   1.59. dlg_bye usage
231
-   1.60. dlg_refer usage
232
-   1.61. dlg_manage usage
233
-   1.62. dlg_bridge usage
234
-   1.63. dlg_get usage
235
-   1.64. is_known_dlg() usage
236
-   1.65. dlg_set_timeout usage
237
-   1.66. dlg_set_timeout_by_profile usage
238
-   1.67. dlg_set_property usage
239
-   1.68. dlg_remote_profile usage
224
+   1.52. Set lreq_callee_headers parameter
225
+   1.53. set_dlg_profile usage
226
+   1.54. unset_dlg_profile usage
227
+   1.55. is_in_profile usage
228
+   1.56. get_profile_size usage
229
+   1.57. dlg_isflagset usage
230
+   1.58. dlg_setflag usage
231
+   1.59. dlg_resetflag usage
232
+   1.60. dlg_bye usage
233
+   1.61. dlg_refer usage
234
+   1.62. dlg_manage usage
235
+   1.63. dlg_bridge usage
236
+   1.64. dlg_get usage
237
+   1.65. is_known_dlg() usage
238
+   1.66. dlg_set_timeout usage
239
+   1.67. dlg_set_timeout_by_profile usage
240
+   1.68. dlg_set_property usage
241
+   1.69. dlg_remote_profile usage
240 242
 
241 243
 Chapter 1. Admin Guide
242 244
 
... ...
@@ -303,6 +305,7 @@ Chapter 1. Admin Guide
303 305
         5.49. timeout_noreset (int)
304 306
         5.50. timer_procs (int)
305 307
         5.51. track_cseq_updates (int)
308
+        5.52. lreq_callee_headers (string)
306 309
 
307 310
    6. Functions
308 311
 
... ...
@@ -506,6 +509,7 @@ Chapter 1. Admin Guide
506 509
    5.49. timeout_noreset (int)
507 510
    5.50. timer_procs (int)
508 511
    5.51. track_cseq_updates (int)
512
+   5.52. lreq_callee_headers (string)
509 513
 
510 514
 5.1. enable_stats (integer)
511 515
 
... ...
@@ -1175,6 +1179,19 @@ modparam("dialog", "timer_procs", 1)
1175 1179
 modparam("dialog", "track_cseq_updates", 1)
1176 1180
 ...
1177 1181
 
1182
+5.52. lreq_callee_headers (string)
1183
+
1184
+   SIP headers to be added when sending local generated requests (e.g.,
1185
+   BYE) to callee. It can be useful when you use topoh module with call-id
1186
+   masking (see the docs of topoh module).
1187
+
1188
+   Default value is "null".
1189
+
1190
+   Example 1.52. Set lreq_callee_headers parameter
1191
+...
1192
+modparam("dialog", "lreq_callee_headers", "TH: dlh\r\n")
1193
+...
1194
+
1178 1195
 6. Functions
1179 1196
 
1180 1197
    6.1. set_dlg_profile(profile,[value])
... ...
@@ -1211,7 +1228,7 @@ modparam("dialog", "track_cseq_updates", 1)
1211 1228
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1212 1229
    and FAILURE_ROUTE.
1213 1230
 
1214
-   Example 1.52. set_dlg_profile usage
1231
+   Example 1.53. set_dlg_profile usage
1215 1232
 ...
1216 1233
 set_dlg_profile("inbound_call");
1217 1234
 set_dlg_profile("caller","$fu");
... ...
@@ -1230,7 +1247,7 @@ set_dlg_profile("caller","$fu");
1230 1247
    This function can be used from BRANCH_ROUTE, REPLY_ROUTE and
1231 1248
    FAILURE_ROUTE.
1232 1249
 
1233
-   Example 1.53. unset_dlg_profile usage
1250
+   Example 1.54. unset_dlg_profile usage
1234 1251
 ...
1235 1252
 unset_dlg_profile("inbound_call");
1236 1253
 unset_dlg_profile("caller","$fu");
... ...
@@ -1253,7 +1270,7 @@ unset_dlg_profile("caller","$fu");
1253 1270
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1254 1271
    and FAILURE_ROUTE.
1255 1272
 
1256
-   Example 1.54. is_in_profile usage
1273
+   Example 1.55. is_in_profile usage
1257 1274
 ...
1258 1275
 if (is_in_profile("inbound_call")) {
1259 1276
         log("this request belongs to a inbound call\n");
... ...
@@ -1282,7 +1299,7 @@ if (is_in_profile("caller","XX")) {
1282 1299
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1283 1300
    and FAILURE_ROUTE.
1284 1301
 
1285
-   Example 1.55. get_profile_size usage
1302
+   Example 1.56. get_profile_size usage
1286 1303
 ...
1287 1304
 if(get_profile_size("inbound_call","$avp(size)"))
1288 1305
     xlog("currently there are $avp(size) inbound calls\n");
... ...
@@ -1301,7 +1318,7 @@ if(get_profile_size("caller","$fu","$avp(size)"))
1301 1318
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1302 1319
    ONREPLY_ROUTE and FAILURE_ROUTE.
1303 1320
 
1304
-   Example 1.56. dlg_isflagset usage
1321
+   Example 1.57. dlg_isflagset usage
1305 1322
 ...
1306 1323
 if(dlg_isflagset("1"))
1307 1324
 {
... ...
@@ -1319,7 +1336,7 @@ if(dlg_isflagset("1"))
1319 1336
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1320 1337
    ONREPLY_ROUTE and FAILURE_ROUTE.
1321 1338
 
1322
-   Example 1.57. dlg_setflag usage
1339
+   Example 1.58. dlg_setflag usage
1323 1340
 ...
1324 1341
 dlg_setflag("1");
1325 1342
 ...
... ...
@@ -1334,7 +1351,7 @@ dlg_setflag("1");
1334 1351
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1335 1352
    ONREPLY_ROUTE and FAILURE_ROUTE.
1336 1353
 
1337
-   Example 1.58. dlg_resetflag usage
1354
+   Example 1.59. dlg_resetflag usage
1338 1355
 ...
1339 1356
 redlg_setflag("1");
1340 1357
 ...
... ...
@@ -1350,7 +1367,7 @@ redlg_setflag("1");
1350 1367
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1351 1368
    ONREPLY_ROUTE and FAILURE_ROUTE.
1352 1369
 
1353
-   Example 1.59. dlg_bye usage
1370
+   Example 1.60. dlg_bye usage
1354 1371
 ...
1355 1372
 dlg_bye("all");
1356 1373
 ...
... ...
@@ -1367,7 +1384,7 @@ dlg_bye("all");
1367 1384
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1368 1385
    ONREPLY_ROUTE and FAILURE_ROUTE.
1369 1386
 
1370
-   Example 1.60. dlg_refer usage
1387
+   Example 1.61. dlg_refer usage
1371 1388
 ...
1372 1389
 dlg_refer("caller", "sip:announcement@kamailio.org");
1373 1390
 ...
... ...
@@ -1380,7 +1397,7 @@ dlg_refer("caller", "sip:announcement@kamailio.org");
1380 1397
 
1381 1398
    This function can be used from REQUEST_ROUTE.
1382 1399
 
1383
-   Example 1.61. dlg_manage usage
1400
+   Example 1.62. dlg_manage usage
1384 1401
 ...
1385 1402
 modparam("dialog", "default_timeout", 100)
1386 1403
 ...
... ...
@@ -1408,7 +1425,7 @@ route {
1408 1425
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1409 1426
    ONREPLY_ROUTE and FAILURE_ROUTE.
1410 1427
 
1411
-   Example 1.62. dlg_bridge usage
1428
+   Example 1.63. dlg_bridge usage
1412 1429
 ...
1413 1430
 dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org",
1414 1431
    "sip:kamailio.org:5080");
... ...
@@ -1427,7 +1444,7 @@ dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org",
1427 1444
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1428 1445
    ONREPLY_ROUTE and FAILURE_ROUTE.
1429 1446
 
1430
-   Example 1.63. dlg_get usage
1447
+   Example 1.64. dlg_get usage
1431 1448
 ...
1432 1449
 if(dlg_get("abcdef", "123", "456"))
1433 1450
 {
... ...
@@ -1451,7 +1468,7 @@ if(dlg_get("abcdef", "123", "456"))
1451 1468
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1452 1469
    and FAILURE_ROUTE.
1453 1470
 
1454
-   Example 1.64. is_known_dlg() usage
1471
+   Example 1.65. is_known_dlg() usage
1455 1472
 ...
1456 1473
 if(!uri == myself) {
1457 1474
         if(is_known_dlg()) {
... ...
@@ -1475,7 +1492,7 @@ if(!uri == myself) {
1475 1492
 
1476 1493
    This function can be used from ANY_ROUTE.
1477 1494
 
1478
-   Example 1.65. dlg_set_timeout usage
1495
+   Example 1.66. dlg_set_timeout usage
1479 1496
 ...
1480 1497
 if(dlg_set_timeout("180", "123", "456"))
1481 1498
 {
... ...
@@ -1497,7 +1514,7 @@ if(dlg_set_timeout("180", "123", "456"))
1497 1514
 
1498 1515
    This function can be used from ANY_ROUTE.
1499 1516
 
1500
-   Example 1.66. dlg_set_timeout_by_profile usage
1517
+   Example 1.67. dlg_set_timeout_by_profile usage
1501 1518
 ...
1502 1519
 # All dialogs belonging to user abc123 (tracked via set_dlg_profile())
1503 1520
 # will be timed out in 3 seconds.
... ...
@@ -1529,7 +1546,7 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
1529 1546
 
1530 1547
    This function can be used from ANY_ROUTE.
1531 1548
 
1532
-   Example 1.67. dlg_set_property usage
1549
+   Example 1.68. dlg_set_property usage
1533 1550
 ...
1534 1551
 dlg_set_property("ka-src");
1535 1552
 dlg_set_property("ka-dst");
... ...
@@ -1557,7 +1574,7 @@ dlg_set_property("timeout-noreset");
1557 1574
 
1558 1575
    This function can be used from ANY_ROUTE.
1559 1576
 
1560
-   Example 1.68. dlg_remote_profile usage
1577
+   Example 1.69. dlg_remote_profile usage
1561 1578
 ...
1562 1579
 $var(exp) = 3600 + $Ts;
1563 1580
 dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");