Browse code

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

Kamailio Dev authored on 17/05/2022 10:46:29
Showing 1 changed files
... ...
@@ -128,15 +128,17 @@ Julien Klingenmeyer
128 128
               7.10. dlg_manage()
129 129
               7.11. dlg_bridge(from, to, op)
130 130
               7.12. dlg_get(callid, ftag, ttag)
131
-              7.13. is_known_dlg()
132
-              7.14. dlg_set_timeout(timeout [, h_entry, h_id])
133
-              7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
134
-              7.16. dlg_set_property(attr)
135
-              7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
136
-              7.18. dlg_set_ruri()
137
-              7.19. dlg_db_load_callid(cival)
138
-              7.20. dlg_db_load_extra()
139
-              7.21. dlg_reset_property(attr)
131
+              7.13. dlg_get_var(callid, ftag, ttag, name, dst)
132
+              7.14. dlg_set_var(callid, ftag, ttag, name, value)
133
+              7.15. is_known_dlg()
134
+              7.16. dlg_set_timeout(timeout [, h_entry, h_id])
135
+              7.17. dlg_set_timeout_by_profile(profile, [value], timeout)
136
+              7.18. dlg_set_property(attr)
137
+              7.19. dlg_remote_profile(cmd, profile, value, uid, expires)
138
+              7.20. dlg_set_ruri()
139
+              7.21. dlg_db_load_callid(cival)
140
+              7.22. dlg_db_load_extra()
141
+              7.23. dlg_reset_property(attr)
140 142
 
141 143
         8. Statistics
142 144
 
... ...
@@ -267,15 +269,17 @@ Julien Klingenmeyer
267 269
    1.73. dlg_manage usage
268 270
    1.74. dlg_bridge usage
269 271
    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
272
+   1.76. dlg_get_var usage
273
+   1.77. dlg_set_var usage
274
+   1.78. is_known_dlg() usage
275
+   1.79. dlg_set_timeout usage
276
+   1.80. dlg_set_timeout_by_profile usage
277
+   1.81. dlg_set_property usage
278
+   1.82. dlg_remote_profile usage
279
+   1.83. dlg_set_ruri() usage
280
+   1.84. dlg_db_load_callid() usage
281
+   1.85. dlg_db_load_extra() usage
282
+   1.86. dlg_reset_property usage
279 283
 
280 284
 Chapter 1. Admin Guide
281 285
 
... ...
@@ -370,15 +374,17 @@ Chapter 1. Admin Guide
370 374
         7.10. dlg_manage()
371 375
         7.11. dlg_bridge(from, to, op)
372 376
         7.12. dlg_get(callid, ftag, ttag)
373
-        7.13. is_known_dlg()
374
-        7.14. dlg_set_timeout(timeout [, h_entry, h_id])
375
-        7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
376
-        7.16. dlg_set_property(attr)
377
-        7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
378
-        7.18. dlg_set_ruri()
379
-        7.19. dlg_db_load_callid(cival)
380
-        7.20. dlg_db_load_extra()
381
-        7.21. dlg_reset_property(attr)
377
+        7.13. dlg_get_var(callid, ftag, ttag, name, dst)
378
+        7.14. dlg_set_var(callid, ftag, ttag, name, value)
379
+        7.15. is_known_dlg()
380
+        7.16. dlg_set_timeout(timeout [, h_entry, h_id])
381
+        7.17. dlg_set_timeout_by_profile(profile, [value], timeout)
382
+        7.18. dlg_set_property(attr)
383
+        7.19. dlg_remote_profile(cmd, profile, value, uid, expires)
384
+        7.20. dlg_set_ruri()
385
+        7.21. dlg_db_load_callid(cival)
386
+        7.22. dlg_db_load_extra()
387
+        7.23. dlg_reset_property(attr)
382 388
 
383 389
    8. Statistics
384 390
 
... ...
@@ -1468,15 +1474,17 @@ modparam("dialog", "keep_proxy_rr", 1)
1468 1474
    7.10. dlg_manage()
1469 1475
    7.11. dlg_bridge(from, to, op)
1470 1476
    7.12. dlg_get(callid, ftag, ttag)
1471
-   7.13. is_known_dlg()
1472
-   7.14. dlg_set_timeout(timeout [, h_entry, h_id])
1473
-   7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
1474
-   7.16. dlg_set_property(attr)
1475
-   7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
1476
-   7.18. dlg_set_ruri()
1477
-   7.19. dlg_db_load_callid(cival)
1478
-   7.20. dlg_db_load_extra()
1479
-   7.21. dlg_reset_property(attr)
1477
+   7.13. dlg_get_var(callid, ftag, ttag, name, dst)
1478
+   7.14. dlg_set_var(callid, ftag, ttag, name, value)
1479
+   7.15. is_known_dlg()
1480
+   7.16. dlg_set_timeout(timeout [, h_entry, h_id])
1481
+   7.17. dlg_set_timeout_by_profile(profile, [value], timeout)
1482
+   7.18. dlg_set_property(attr)
1483
+   7.19. dlg_remote_profile(cmd, profile, value, uid, expires)
1484
+   7.20. dlg_set_ruri()
1485
+   7.21. dlg_db_load_callid(cival)
1486
+   7.22. dlg_db_load_extra()
1487
+   7.23. dlg_reset_property(attr)
1480 1488
 
1481 1489
 7.1.  set_dlg_profile(profile,[value])
1482 1490
 
... ...
@@ -1719,7 +1727,53 @@ if(dlg_get("abcdef", "123", "456"))
1719 1727
 }
1720 1728
 ...
1721 1729
 
1722
-7.13.  is_known_dlg()
1730
+7.13.  dlg_get_var(callid, ftag, ttag, name, dst)
1731
+
1732
+   Get dlg_var of another dialog value based on Call-ID, From-Tag and
1733
+   To-Tag parameters.
1734
+
1735
+   Meaning of the parameters is as follows:
1736
+     * callid - SIP call-id.
1737
+     * ftag - SIP From tag.
1738
+     * ttag - SIP To tag.
1739
+     * name - key name of the $dlg_var.
1740
+     * dst - pv to store the value of $dlg_var(name).
1741
+
1742
+   This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1743
+   ONREPLY_ROUTE and FAILURE_ROUTE.
1744
+
1745
+   Example 1.76. dlg_get_var usage
1746
+...
1747
+if(dlg_get_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
1748
+{
1749
+        xdbg("$$dlg_var(test):$var(tmp)\n");
1750
+}
1751
+...
1752
+
1753
+7.14.  dlg_set_var(callid, ftag, ttag, name, value)
1754
+
1755
+   Set dlg_var of another dialog value based on Call-ID, From-Tag and
1756
+   To-Tag parameters.
1757
+
1758
+   Meaning of the parameters is as follows:
1759
+     * callid - SIP call-id.
1760
+     * ftag - SIP From tag.
1761
+     * ttag - SIP To tag.
1762
+     * name - key name of the $dlg_var.
1763
+     * value - string value to store at $dlg_var(name).
1764
+
1765
+   This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
1766
+   ONREPLY_ROUTE and FAILURE_ROUTE.
1767
+
1768
+   Example 1.77. dlg_set_var usage
1769
+...
1770
+if(dlg_set_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
1771
+{
1772
+        xdbg("set $$dlg_var(test):$var(tmp)\n");
1773
+}
1774
+...
1775
+
1776
+7.15.  is_known_dlg()
1723 1777
 
1724 1778
    This function checks if the current SIP message being processed belongs
1725 1779
    to any transaction within an active dialog that the dialog module is
... ...
@@ -1735,7 +1789,7 @@ if(dlg_get("abcdef", "123", "456"))
1735 1789
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
1736 1790
    and FAILURE_ROUTE.
1737 1791
 
1738
-   Example 1.76. is_known_dlg() usage
1792
+   Example 1.78. is_known_dlg() usage
1739 1793
 ...
1740 1794
 if(!uri == myself) {
1741 1795
         if(is_known_dlg()) {
... ...
@@ -1744,7 +1798,7 @@ if(!uri == myself) {
1744 1798
 }
1745 1799
 ...
1746 1800
 
1747
-7.14.  dlg_set_timeout(timeout [, h_entry, h_id])
1801
+7.16.  dlg_set_timeout(timeout [, h_entry, h_id])
1748 1802
 
1749 1803
    Set the dialog timeout. Dialog timeout will be updated if it was
1750 1804
    already set. If h_entry and h_id parameters are not provided, the
... ...
@@ -1759,7 +1813,7 @@ if(!uri == myself) {
1759 1813
 
1760 1814
    This function can be used from ANY_ROUTE.
1761 1815
 
1762
-   Example 1.77. dlg_set_timeout usage
1816
+   Example 1.79. dlg_set_timeout usage
1763 1817
 ...
1764 1818
 if(dlg_set_timeout("180", "123", "456"))
1765 1819
 {
... ...
@@ -1767,7 +1821,7 @@ if(dlg_set_timeout("180", "123", "456"))
1767 1821
 }
1768 1822
 ...
1769 1823
 
1770
-7.15.  dlg_set_timeout_by_profile(profile, [value], timeout)
1824
+7.17.  dlg_set_timeout_by_profile(profile, [value], timeout)
1771 1825
 
1772 1826
    Like dlg_set_timeout(), but simultaneously sets the timeout of all
1773 1827
    dialogs in a given profile. Can be constrained by profile value.
... ...
@@ -1781,7 +1835,7 @@ if(dlg_set_timeout("180", "123", "456"))
1781 1835
 
1782 1836
    This function can be used from ANY_ROUTE.
1783 1837
 
1784
-   Example 1.78. dlg_set_timeout_by_profile usage
1838
+   Example 1.80. dlg_set_timeout_by_profile usage
1785 1839
 ...
1786 1840
 # All dialogs belonging to user abc123 (tracked via set_dlg_profile())
1787 1841
 # will be timed out in 3 seconds.
... ...
@@ -1789,7 +1843,7 @@ if(dlg_set_timeout("180", "123", "456"))
1789 1843
 dlg_set_timeout_by_profile("users", "abc123", "3");
1790 1844
 ...
1791 1845
 
1792
-7.16.  dlg_set_property(attr)
1846
+7.18.  dlg_set_property(attr)
1793 1847
 
1794 1848
    Set a dialog property - an attribute that enable/disable various
1795 1849
    behaviours (e.g., sending keep alive requests).
... ...
@@ -1813,14 +1867,14 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
1813 1867
 
1814 1868
    This function can be used from ANY_ROUTE.
1815 1869
 
1816
-   Example 1.79. dlg_set_property usage
1870
+   Example 1.81. dlg_set_property usage
1817 1871
 ...
1818 1872
 dlg_set_property("ka-src");
1819 1873
 dlg_set_property("ka-dst");
1820 1874
 dlg_set_property("timeout-noreset");
1821 1875
 ...
1822 1876
 
1823
-7.17.  dlg_remote_profile(cmd, profile, value, uid, expires)
1877
+7.19.  dlg_remote_profile(cmd, profile, value, uid, expires)
1824 1878
 
1825 1879
    Manage remote profile via config file. A remote profile item is
1826 1880
    considered when the dialog is not managed by this server instance. The
... ...
@@ -1841,20 +1895,20 @@ dlg_set_property("timeout-noreset");
1841 1895
 
1842 1896
    This function can be used from ANY_ROUTE.
1843 1897
 
1844
-   Example 1.80. dlg_remote_profile usage
1898
+   Example 1.82. dlg_remote_profile usage
1845 1899
 ...
1846 1900
 $var(exp) = 3600 + $Ts;
1847 1901
 dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
1848 1902
 ...
1849 1903
 
1850
-7.18.  dlg_set_ruri()
1904
+7.20.  dlg_set_ruri()
1851 1905
 
1852 1906
    This function sets the R-URI with the corresponding endpoint address
1853 1907
    stored in dialog structure (i.e., its Contact field).
1854 1908
 
1855 1909
    This function can be used from ANY_ROUTE.
1856 1910
 
1857
-   Example 1.81. dlg_set_ruri() usage
1911
+   Example 1.83. dlg_set_ruri() usage
1858 1912
 ...
1859 1913
 if(has_totag() and is_present_hf("Route") and uri==myself ) {
1860 1914
         if(dlg_set_ruri()) {
... ...
@@ -1863,14 +1917,14 @@ if(has_totag() and is_present_hf("Route") and uri==myself ) {
1863 1917
 }
1864 1918
 ...
1865 1919
 
1866
-7.19.  dlg_db_load_callid(cival)
1920
+7.21.  dlg_db_load_callid(cival)
1867 1921
 
1868 1922
    Load dialog record from database matching on Call-Id provided as
1869 1923
    parameter.
1870 1924
 
1871 1925
    This function can be used from ANY_ROUTE.
1872 1926
 
1873
-   Example 1.82. dlg_db_load_callid() usage
1927
+   Example 1.84. dlg_db_load_callid() usage
1874 1928
 ...
1875 1929
 if(has_totag()) {
1876 1930
     if(!is_known_dlg()) {
... ...
@@ -1882,14 +1936,14 @@ if(has_totag()) {
1882 1936
 }
1883 1937
 ...
1884 1938
 
1885
-7.20.  dlg_db_load_extra()
1939
+7.22.  dlg_db_load_extra()
1886 1940
 
1887 1941
    Load all dialog records from database that are not in memory of the
1888 1942
    current Kamailio instance.
1889 1943
 
1890 1944
    This function can be used from ANY_ROUTE.
1891 1945
 
1892
-   Example 1.83. dlg_db_load_extra() usage
1946
+   Example 1.85. dlg_db_load_extra() usage
1893 1947
 ...
1894 1948
 if(has_totag()) {
1895 1949
     if(!is_known_dlg()) {
... ...
@@ -1901,7 +1955,7 @@ if(has_totag()) {
1901 1955
 }
1902 1956
 ...
1903 1957
 
1904
-7.21.  dlg_reset_property(attr)
1958
+7.23.  dlg_reset_property(attr)
1905 1959
 
1906 1960
    Reset a dialog property - an attribute that enable/disable various
1907 1961
    behaviours (e.g., sending keep alive requests).
... ...
@@ -1915,7 +1969,7 @@ if(has_totag()) {
1915 1969
 
1916 1970
    This function can be used from ANY_ROUTE.
1917 1971
 
1918
-   Example 1.84. dlg_reset_property usage
1972
+   Example 1.86. dlg_reset_property usage
1919 1973
 ...
1920 1974
 dlg_reset_property("ka-src");
1921 1975
 dlg_reset_property("ka-dst");