Browse code

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

Kamailio Dev authored on 30/10/2019 12:46:11
Showing 1 changed files
... ...
@@ -154,7 +154,7 @@ Julien Klingenmeyer
154 154
               9.6. dlg.dlg_list_ctx
155 155
               9.7. dlg.terminate_dlg
156 156
               9.8. dlg.end_dlg
157
-              9.9. dlg.kill_active_dlg
157
+              9.9. dlg.set_state
158 158
               9.10. dlg.profile_get_size
159 159
               9.11. dlg.profile_list
160 160
               9.12. dlg.bridge_dlg
... ...
@@ -390,7 +390,7 @@ Chapter 1. Admin Guide
390 390
         9.6. dlg.dlg_list_ctx
391 391
         9.7. dlg.terminate_dlg
392 392
         9.8. dlg.end_dlg
393
-        9.9. dlg.kill_active_dlg
393
+        9.9. dlg.set_state
394 394
         9.10. dlg.profile_get_size
395 395
         9.11. dlg.profile_list
396 396
         9.12. dlg.bridge_dlg
... ...
@@ -1912,7 +1912,7 @@ if(has_totag()) {
1912 1912
    9.6. dlg.dlg_list_ctx
1913 1913
    9.7. dlg.terminate_dlg
1914 1914
    9.8. dlg.end_dlg
1915
-   9.9. dlg.kill_active_dlg
1915
+   9.9. dlg.set_state
1916 1916
    9.10. dlg.profile_get_size
1917 1917
    9.11. dlg.profile_list
1918 1918
    9.12. dlg.bridge_dlg
... ...
@@ -2053,10 +2053,10 @@ kamcmd dlg.list_ctx abcdrssfrs122444@192.168.1.1
2053 2053
 kamcmd dlg.end_dlg 342 56
2054 2054
 ...
2055 2055
 
2056
-9.9. dlg.kill_active_dlg
2056
+9.9. dlg.set_state
2057 2057
 
2058
-   Kills a given active dialog matching the dialog on Call-ID, From-Tag
2059
-   and To-Tag.
2058
+   Set state for the dialog matching the dialog on Call-ID, From-Tag and
2059
+   To-Tag.
2060 2060
 
2061 2061
    Name: dlg.kill_active_dlg
2062 2062
 
... ...
@@ -2064,18 +2064,21 @@ kamcmd dlg.end_dlg 342 56
2064 2064
      * callid - Call-ID of active dialog to kill
2065 2065
      * from_tag - From-Tag of active dialog to kill
2066 2066
      * to_tag - To-tag of active dialog to kill
2067
-
2068
-   This command only handles active dialogs (state 4), error is returned
2069
-   otherwise. Please be careful with it, it callously wipes out the given
2070
-   dialog: dialog ending functions will not be called, such as accounting
2071
-   end-of-call events, dialog-end events, module-generated BYE requests,
2072
-   etc. After executing the command, dialog remains in memory until
2073
-   execution of the recurring function in charge of removing old dialogs
2074
-   (a "dialog in delete state is too old" will then be logged).
2067
+     * state - The value for new state
2068
+
2069
+   At this moment, the command targets the need to change from active
2070
+   dialogs (state 4) to terminated state (5), although it allows setting
2071
+   other state value. Be careful using with it, it can cause side effects
2072
+   and the terminated dialog is wiped out silently. Dialog ending
2073
+   functions are not executed, such as accounting end-of-call events,
2074
+   dialog-end events, module-generated BYE requests, etc. After executing
2075
+   the command, dialog remains in memory until execution of the recurring
2076
+   function in charge of removing old dialogs (a "dialog in delete state
2077
+   is too old" will then be logged).
2075 2078
 
2076 2079
    RPC Command Format:
2077 2080
 ...
2078
-kamcmd dlg.kill_active_dlg callid12345 fromtag123 totag123
2081
+kamcmd dlg.set_state callid12345 fromtag123 totag123 5
2079 2082
 ...
2080 2083
 
2081 2084
 9.10. dlg.profile_get_size