Browse code

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

Kamailio Dev authored on 08/04/2020 02:16:09
Showing 1 changed files
... ...
@@ -151,17 +151,18 @@ Julien Klingenmeyer
151 151
               9.2. dlg.list_ctx
152 152
               9.3. dlg.list_match
153 153
               9.4. dlg.list_match_ctx
154
-              9.5. dlg.dlg_list
155
-              9.6. dlg.dlg_list_ctx
156
-              9.7. dlg.terminate_dlg
157
-              9.8. dlg.end_dlg
158
-              9.9. dlg.set_state
159
-              9.10. dlg.profile_get_size
160
-              9.11. dlg.profile_list
161
-              9.12. dlg.bridge_dlg
162
-              9.13. dlg.stats_active
163
-              9.14. dlg.is_alive
164
-              9.15. dlg.briefing
154
+              9.5. dlg.dump_file
155
+              9.6. dlg.dlg_list
156
+              9.7. dlg.dlg_list_ctx
157
+              9.8. dlg.terminate_dlg
158
+              9.9. dlg.end_dlg
159
+              9.10. dlg.set_state
160
+              9.11. dlg.profile_get_size
161
+              9.12. dlg.profile_list
162
+              9.13. dlg.bridge_dlg
163
+              9.14. dlg.stats_active
164
+              9.15. dlg.is_alive
165
+              9.16. dlg.briefing
165 166
 
166 167
         10. Exported Variables
167 168
 
... ...
@@ -390,17 +391,18 @@ Chapter 1. Admin Guide
390 391
         9.2. dlg.list_ctx
391 392
         9.3. dlg.list_match
392 393
         9.4. dlg.list_match_ctx
393
-        9.5. dlg.dlg_list
394
-        9.6. dlg.dlg_list_ctx
395
-        9.7. dlg.terminate_dlg
396
-        9.8. dlg.end_dlg
397
-        9.9. dlg.set_state
398
-        9.10. dlg.profile_get_size
399
-        9.11. dlg.profile_list
400
-        9.12. dlg.bridge_dlg
401
-        9.13. dlg.stats_active
402
-        9.14. dlg.is_alive
403
-        9.15. dlg.briefing
394
+        9.5. dlg.dump_file
395
+        9.6. dlg.dlg_list
396
+        9.7. dlg.dlg_list_ctx
397
+        9.8. dlg.terminate_dlg
398
+        9.9. dlg.end_dlg
399
+        9.10. dlg.set_state
400
+        9.11. dlg.profile_get_size
401
+        9.12. dlg.profile_list
402
+        9.13. dlg.bridge_dlg
403
+        9.14. dlg.stats_active
404
+        9.15. dlg.is_alive
405
+        9.16. dlg.briefing
404 406
 
405 407
    10. Exported Variables
406 408
 
... ...
@@ -1935,17 +1937,18 @@ dlg_reset_property("timeout-noreset");
1935 1937
    9.2. dlg.list_ctx
1936 1938
    9.3. dlg.list_match
1937 1939
    9.4. dlg.list_match_ctx
1938
-   9.5. dlg.dlg_list
1939
-   9.6. dlg.dlg_list_ctx
1940
-   9.7. dlg.terminate_dlg
1941
-   9.8. dlg.end_dlg
1942
-   9.9. dlg.set_state
1943
-   9.10. dlg.profile_get_size
1944
-   9.11. dlg.profile_list
1945
-   9.12. dlg.bridge_dlg
1946
-   9.13. dlg.stats_active
1947
-   9.14. dlg.is_alive
1948
-   9.15. dlg.briefing
1940
+   9.5. dlg.dump_file
1941
+   9.6. dlg.dlg_list
1942
+   9.7. dlg.dlg_list_ctx
1943
+   9.8. dlg.terminate_dlg
1944
+   9.9. dlg.end_dlg
1945
+   9.10. dlg.set_state
1946
+   9.11. dlg.profile_get_size
1947
+   9.12. dlg.profile_list
1948
+   9.13. dlg.bridge_dlg
1949
+   9.14. dlg.stats_active
1950
+   9.15. dlg.is_alive
1951
+   9.16. dlg.briefing
1949 1952
 
1950 1953
 9.1. dlg.list
1951 1954
 
... ...
@@ -2008,7 +2011,21 @@ kamcmd dlg.list_match furi sw sip:alice@
2008 2011
 kamcmd dlg.list_match_ctx furi sw sip:alice@
2009 2012
 ...
2010 2013
 
2011
-9.5. dlg.dlg_list
2014
+9.5. dlg.dump_file
2015
+
2016
+   Dump all dialogs in a json file. (much faster than dlg.list)
2017
+
2018
+   Name: dlg.dump_file
2019
+
2020
+   Parameters:
2021
+     * file name output file name
2022
+
2023
+   RPC Command Format:
2024
+...
2025
+kamcmd dlg.dump_file "/tmp/dlg.json"
2026
+...
2027
+
2028
+9.6. dlg.dlg_list
2012 2029
 
2013 2030
    Lists the description of one dialog. The dialog identifiers are to be
2014 2031
    passed as parameter (callid and optionally fromtag).
... ...
@@ -2027,7 +2044,7 @@ kamcmd dlg.dlg_list abcdrssfrs122444@192.168.1.1 AAdfeEFF33
2027 2044
 kamcmd dlg.dlg_list abcdrssfrs122444@192.168.1.1
2028 2045
 ...
2029 2046
 
2030
-9.6. dlg.dlg_list_ctx
2047
+9.7. dlg.dlg_list_ctx
2031 2048
 
2032 2049
    The same as the “dlg.list_list” but including in the dialog description
2033 2050
    the associated context from modules sitting on top of the dialog
... ...
@@ -2044,7 +2061,7 @@ kamcmd dlg.list_ctx abcdrssfrs122444@192.168.1.1 AAdfeEFF33
2044 2061
 kamcmd dlg.list_ctx abcdrssfrs122444@192.168.1.1
2045 2062
 ...
2046 2063
 
2047
-9.7. dlg.terminate_dlg
2064
+9.8. dlg.terminate_dlg
2048 2065
 
2049 2066
    Terminates an ongoing dialog by sending BYE in both directions,
2050 2067
    matching the dialog on call-id, from tag and to tag.
... ...
@@ -2061,7 +2078,7 @@ kamcmd dlg.list_ctx abcdrssfrs122444@192.168.1.1
2061 2078
    RPC Command Format:
2062 2079
                 kamcmd dlg.terminate_dlg callid12345 fromtag123 totag123
2063 2080
 
2064
-9.8. dlg.end_dlg
2081
+9.9. dlg.end_dlg
2065 2082
 
2066 2083
    Terminates an ongoing dialog by sending BYE in both directions.
2067 2084
 
... ...
@@ -2081,7 +2098,7 @@ kamcmd dlg.list_ctx abcdrssfrs122444@192.168.1.1
2081 2098
 kamcmd dlg.end_dlg 342 56
2082 2099
 ...
2083 2100
 
2084
-9.9. dlg.set_state
2101
+9.10. dlg.set_state
2085 2102
 
2086 2103
    Set state for the dialog matching the dialog on Call-ID, From-Tag and
2087 2104
    To-Tag.
... ...
@@ -2109,7 +2126,7 @@ kamcmd dlg.end_dlg 342 56
2109 2126
 kamcmd dlg.set_state callid12345 fromtag123 totag123 5
2110 2127
 ...
2111 2128
 
2112
-9.10. dlg.profile_get_size
2129
+9.11. dlg.profile_get_size
2113 2130
 
2114 2131
    Returns the number of dialogs belonging to a profile. If the profile
2115 2132
    supports values, the check can be reinforced to take into account a
... ...
@@ -2129,7 +2146,7 @@ kamcmd dlg.set_state callid12345 fromtag123 totag123 5
2129 2146
 kamcmd dlg.dlg.profile_get_size inbound_calls
2130 2147
 ...
2131 2148
 
2132
-9.11. dlg.profile_list
2149
+9.12. dlg.profile_list
2133 2150
 
2134 2151
    Lists all the dialogs belonging to a profile. If the profile supports
2135 2152
    values, the check can be reinforced to take into account a specific
... ...
@@ -2149,7 +2166,7 @@ kamcmd dlg.dlg.profile_get_size inbound_calls
2149 2166
 kamcmd dlg.profile_list inbound_calls
2150 2167
 ...
2151 2168
 
2152
-9.12. dlg.bridge_dlg
2169
+9.13. dlg.bridge_dlg
2153 2170
 
2154 2171
    Bridge two SIP addresses into a call using INVITE(hold)-REFER-BYE
2155 2172
    mechanism.
... ...
@@ -2174,7 +2191,7 @@ kamcmd dlg.profile_list inbound_calls
2174 2191
 kamcmd dlg.bridge_dlg _from_ _to_ _op_
2175 2192
 ...
2176 2193
 
2177
-9.13. dlg.stats_active
2194
+9.14. dlg.stats_active
2178 2195
 
2179 2196
    Get stats about active dialogs by scanning internal list of dialogs
2180 2197
    (not relying on core stats framework).
... ...
@@ -2198,7 +2215,7 @@ kamcmd dlg.bridge_dlg _from_ _to_ _op_
2198 2215
 kamcmd dlg.stats_active
2199 2216
 ...
2200 2217
 
2201
-9.14. dlg.is_alive
2218
+9.15. dlg.is_alive
2202 2219
 
2203 2220
    Check whether a dialog matching the parameter is in confirmed state
2204 2221
    (answered and alive).
... ...
@@ -2218,7 +2235,7 @@ kamcmd dlg.stats_active
2218 2235
 kamcmd dlg.is_alive callid123 fromtag123 totag123
2219 2236
 ...
2220 2237
 
2221
-9.15. dlg.briefing
2238
+9.16. dlg.briefing
2222 2239
 
2223 2240
    Lists fewer attributes for dialog records in memory.
2224 2241