Browse code

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

Kamailio Dev authored on 12/06/2020 08:31:20
Showing 1 changed files
... ...
@@ -112,6 +112,7 @@ Julien Klingenmeyer
112 112
               6.60. h_id_start (int)
113 113
               6.61. h_id_step (int)
114 114
               6.62. keep_proxy_rr (string)
115
+              6.63. update_all_states (string)
115 116
 
116 117
         7. Functions
117 118
 
... ...
@@ -253,27 +254,28 @@ Julien Klingenmeyer
253 254
    1.60. Set h_id_start parameter
254 255
    1.61. Set h_id_step parameter
255 256
    1.62. Set dlg_keep_proxy_rr parameter
256
-   1.63. set_dlg_profile usage
257
-   1.64. unset_dlg_profile usage
258
-   1.65. is_in_profile usage
259
-   1.66. get_profile_size usage
260
-   1.67. dlg_isflagset usage
261
-   1.68. dlg_setflag usage
262
-   1.69. dlg_resetflag usage
263
-   1.70. dlg_bye usage
264
-   1.71. dlg_refer usage
265
-   1.72. dlg_manage usage
266
-   1.73. dlg_bridge usage
267
-   1.74. dlg_get usage
268
-   1.75. is_known_dlg() usage
269
-   1.76. dlg_set_timeout usage
270
-   1.77. dlg_set_timeout_by_profile usage
271
-   1.78. dlg_set_property usage
272
-   1.79. dlg_remote_profile usage
273
-   1.80. dlg_set_ruri() usage
274
-   1.81. dlg_db_load_callid() usage
275
-   1.82. dlg_db_load_extra() usage
276
-   1.83. dlg_reset_property usage
257
+   1.63. Set update_all_states parameter
258
+   1.64. set_dlg_profile usage
259
+   1.65. unset_dlg_profile usage
260
+   1.66. is_in_profile usage
261
+   1.67. get_profile_size usage
262
+   1.68. dlg_isflagset usage
263
+   1.69. dlg_setflag usage
264
+   1.70. dlg_resetflag usage
265
+   1.71. dlg_bye usage
266
+   1.72. dlg_refer usage
267
+   1.73. dlg_manage usage
268
+   1.74. dlg_bridge usage
269
+   1.75. dlg_get usage
270
+   1.76. is_known_dlg() usage
271
+   1.77. dlg_set_timeout usage
272
+   1.78. dlg_set_timeout_by_profile usage
273
+   1.79. dlg_set_property usage
274
+   1.80. dlg_remote_profile usage
275
+   1.81. dlg_set_ruri() usage
276
+   1.82. dlg_db_load_callid() usage
277
+   1.83. dlg_db_load_extra() usage
278
+   1.84. dlg_reset_property usage
277 279
 
278 280
 Chapter 1. Admin Guide
279 281
 
... ...
@@ -352,6 +354,7 @@ Chapter 1. Admin Guide
352 354
         6.60. h_id_start (int)
353 355
         6.61. h_id_step (int)
354 356
         6.62. keep_proxy_rr (string)
357
+        6.63. update_all_states (string)
355 358
 
356 359
    7. Functions
357 360
 
... ...
@@ -468,8 +471,8 @@ Chapter 1. Admin Guide
468 471
      * 4 : Confirmed dialog (active call)
469 472
      * 5 : Deleted dialog
470 473
 
471
-   The early and deleted dialog states are not updated in database
472
-   storage.
474
+   The early and deleted dialog states are updated in database storage,
475
+   unless deactivated with the update_all_states parameter.
473 476
 
474 477
 4. Dialog profiling
475 478
 
... ...
@@ -583,6 +586,7 @@ Chapter 1. Admin Guide
583 586
    6.60. h_id_start (int)
584 587
    6.61. h_id_step (int)
585 588
    6.62. keep_proxy_rr (string)
589
+   6.63. update_all_states (string)
586 590
 
587 591
 6.1. enable_stats (integer)
588 592
 
... ...
@@ -1435,6 +1439,24 @@ modparam("dialog", "h_id_step", 10)
1435 1439
 modparam("dialog", "keep_proxy_rr", 1)
1436 1440
 ...
1437 1441
 
1442
+6.63. update_all_states (string)
1443
+
1444
+   When enabled the dialog modules will also synchronize the early and
1445
+   deleted dialog states to the database. This is useful in failover
1446
+   situations, but of course will generate more load to the database from
1447
+   this module.
1448
+
1449
+   Valid values are:
1450
+     * 0 - Don't synchronize early and deleted dialogs
1451
+     * 1 - Synchronize early and deleted dialogs
1452
+
1453
+   Default value is “1”.
1454
+
1455
+   Example 1.63. Set update_all_states parameter
1456
+...
1457
+modparam("dialog", "update_all_states", 1)
1458
+...
1459
+
1438 1460
 7. Functions
1439 1461
 
1440 1462
    7.1. set_dlg_profile(profile,[value])
... ...
@@ -1475,7 +1497,7 @@ modparam("dialog", "keep_proxy_rr", 1)
1475 1497
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1476 1498
    and FAILURE_ROUTE.
1477 1499
 
1478
-   Example 1.63. set_dlg_profile usage
1500
+   Example 1.64. set_dlg_profile usage
1479 1501
 ...
1480 1502
 set_dlg_profile("inbound_call");
1481 1503
 set_dlg_profile("caller","$fu");
... ...
@@ -1494,7 +1516,7 @@ set_dlg_profile("caller","$fu");
1494 1516
    This function can be used from BRANCH_ROUTE, REPLY_ROUTE and
1495 1517
    FAILURE_ROUTE.
1496 1518
 
1497
-   Example 1.64. unset_dlg_profile usage
1519
+   Example 1.65. unset_dlg_profile usage
1498 1520
 ...
1499 1521
 unset_dlg_profile("inbound_call");
1500 1522
 unset_dlg_profile("caller","$fu");
... ...
@@ -1517,7 +1539,7 @@ unset_dlg_profile("caller","$fu");
1517 1539
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1518 1540
    and FAILURE_ROUTE.
1519 1541
 
1520
-   Example 1.65. is_in_profile usage
1542
+   Example 1.66. is_in_profile usage
1521 1543
 ...
1522 1544
 if (is_in_profile("inbound_call")) {
1523 1545
         log("this request belongs to a inbound call\n");
... ...
@@ -1547,7 +1569,7 @@ if (is_in_profile("caller","XX")) {
1547 1569
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1548 1570
    and FAILURE_ROUTE.
1549 1571
 
1550
-   Example 1.66. get_profile_size usage
1572
+   Example 1.67. get_profile_size usage
1551 1573
 ...
1552 1574
 if(get_profile_size("inbound_call","$avp(size)"))
1553 1575
     xlog("currently there are $avp(size) inbound calls\n");
... ...
@@ -1566,7 +1588,7 @@ if(get_profile_size("caller","$fu","$avp(size)"))
1566 1588
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1567 1589
    ONREPLY_ROUTE and FAILURE_ROUTE.
1568 1590
 
1569
-   Example 1.67. dlg_isflagset usage
1591
+   Example 1.68. dlg_isflagset usage
1570 1592
 ...
1571 1593
 if(dlg_isflagset("1"))
1572 1594
 {
... ...
@@ -1584,7 +1606,7 @@ if(dlg_isflagset("1"))
1584 1606
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1585 1607
    ONREPLY_ROUTE and FAILURE_ROUTE.
1586 1608
 
1587
-   Example 1.68. dlg_setflag usage
1609
+   Example 1.69. dlg_setflag usage
1588 1610
 ...
1589 1611
 dlg_setflag("1");
1590 1612
 ...
... ...
@@ -1599,7 +1621,7 @@ dlg_setflag("1");
1599 1621
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1600 1622
    ONREPLY_ROUTE and FAILURE_ROUTE.
1601 1623
 
1602
-   Example 1.69. dlg_resetflag usage
1624
+   Example 1.70. dlg_resetflag usage
1603 1625
 ...
1604 1626
 redlg_setflag("1");
1605 1627
 ...
... ...
@@ -1614,7 +1636,7 @@ redlg_setflag("1");
1614 1636
 
1615 1637
    This function can be used from ANY_ROUTE.
1616 1638
 
1617
-   Example 1.70. dlg_bye usage
1639
+   Example 1.71. dlg_bye usage
1618 1640
 ...
1619 1641
 dlg_bye("all");
1620 1642
 ...
... ...
@@ -1631,7 +1653,7 @@ dlg_bye("all");
1631 1653
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1632 1654
    ONREPLY_ROUTE and FAILURE_ROUTE.
1633 1655
 
1634
-   Example 1.71. dlg_refer usage
1656
+   Example 1.72. dlg_refer usage
1635 1657
 ...
1636 1658
 dlg_refer("caller", "sip:announcement@kamailio.org");
1637 1659
 ...
... ...
@@ -1644,7 +1666,7 @@ dlg_refer("caller", "sip:announcement@kamailio.org");
1644 1666
 
1645 1667
    This function can be used from REQUEST_ROUTE.
1646 1668
 
1647
-   Example 1.72. dlg_manage usage
1669
+   Example 1.73. dlg_manage usage
1648 1670
 ...
1649 1671
 modparam("dialog", "default_timeout", 100)
1650 1672
 ...
... ...
@@ -1672,7 +1694,7 @@ request_route {
1672 1694
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1673 1695
    ONREPLY_ROUTE and FAILURE_ROUTE.
1674 1696
 
1675
-   Example 1.73. dlg_bridge usage
1697
+   Example 1.74. dlg_bridge usage
1676 1698
 ...
1677 1699
 dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org",
1678 1700
    "sip:kamailio.org:5080");
... ...
@@ -1691,7 +1713,7 @@ dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org",
1691 1713
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1692 1714
    ONREPLY_ROUTE and FAILURE_ROUTE.
1693 1715
 
1694
-   Example 1.74. dlg_get usage
1716
+   Example 1.75. dlg_get usage
1695 1717
 ...
1696 1718
 if(dlg_get("abcdef", "123", "456"))
1697 1719
 {
... ...
@@ -1715,7 +1737,7 @@ if(dlg_get("abcdef", "123", "456"))
1715 1737
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1716 1738
    and FAILURE_ROUTE.
1717 1739
 
1718
-   Example 1.75. is_known_dlg() usage
1740
+   Example 1.76. is_known_dlg() usage
1719 1741
 ...
1720 1742
 if(!uri == myself) {
1721 1743
         if(is_known_dlg()) {
... ...
@@ -1739,7 +1761,7 @@ if(!uri == myself) {
1739 1761
 
1740 1762
    This function can be used from ANY_ROUTE.
1741 1763
 
1742
-   Example 1.76. dlg_set_timeout usage
1764
+   Example 1.77. dlg_set_timeout usage
1743 1765
 ...
1744 1766
 if(dlg_set_timeout("180", "123", "456"))
1745 1767
 {
... ...
@@ -1761,7 +1783,7 @@ if(dlg_set_timeout("180", "123", "456"))
1761 1783
 
1762 1784
    This function can be used from ANY_ROUTE.
1763 1785
 
1764
-   Example 1.77. dlg_set_timeout_by_profile usage
1786
+   Example 1.78. dlg_set_timeout_by_profile usage
1765 1787
 ...
1766 1788
 # All dialogs belonging to user abc123 (tracked via set_dlg_profile())
1767 1789
 # will be timed out in 3 seconds.
... ...
@@ -1793,7 +1815,7 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
1793 1815
 
1794 1816
    This function can be used from ANY_ROUTE.
1795 1817
 
1796
-   Example 1.78. dlg_set_property usage
1818
+   Example 1.79. dlg_set_property usage
1797 1819
 ...
1798 1820
 dlg_set_property("ka-src");
1799 1821
 dlg_set_property("ka-dst");
... ...
@@ -1821,7 +1843,7 @@ dlg_set_property("timeout-noreset");
1821 1843
 
1822 1844
    This function can be used from ANY_ROUTE.
1823 1845
 
1824
-   Example 1.79. dlg_remote_profile usage
1846
+   Example 1.80. dlg_remote_profile usage
1825 1847
 ...
1826 1848
 $var(exp) = 3600 + $Ts;
1827 1849
 dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
... ...
@@ -1834,7 +1856,7 @@ dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
1834 1856
 
1835 1857
    This function can be used from ANY_ROUTE.
1836 1858
 
1837
-   Example 1.80. dlg_set_ruri() usage
1859
+   Example 1.81. dlg_set_ruri() usage
1838 1860
 ...
1839 1861
 if(has_totag() and is_present_hf("Route") and uri==myself ) {
1840 1862
         if(dlg_set_ruri()) {
... ...
@@ -1850,7 +1872,7 @@ if(has_totag() and is_present_hf("Route") and uri==myself ) {
1850 1872
 
1851 1873
    This function can be used from ANY_ROUTE.
1852 1874
 
1853
-   Example 1.81. dlg_db_load_callid() usage
1875
+   Example 1.82. dlg_db_load_callid() usage
1854 1876
 ...
1855 1877
 if(has_totag()) {
1856 1878
     if(!is_known_dlg()) {
... ...
@@ -1869,7 +1891,7 @@ if(has_totag()) {
1869 1891
 
1870 1892
    This function can be used from ANY_ROUTE.
1871 1893
 
1872
-   Example 1.82. dlg_db_load_extra() usage
1894
+   Example 1.83. dlg_db_load_extra() usage
1873 1895
 ...
1874 1896
 if(has_totag()) {
1875 1897
     if(!is_known_dlg()) {
... ...
@@ -1895,7 +1917,7 @@ if(has_totag()) {
1895 1917
 
1896 1918
    This function can be used from ANY_ROUTE.
1897 1919
 
1898
-   Example 1.83. dlg_reset_property usage
1920
+   Example 1.84. dlg_reset_property usage
1899 1921
 ...
1900 1922
 dlg_reset_property("ka-src");
1901 1923
 dlg_reset_property("ka-dst");