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

src/modules/dialog/README

@@ -26,6 +26,10 @@ Surendra Tiwari
 
    <[email protected]>
 
+Julien Klingenmeyer
+
+   <[email protected]>
+
    Copyright © 2006 Voice Sistem SRL
 
    Copyright © 2011 Carsten Bock, http://www.ng-voice.com
@@ -150,11 +154,12 @@ Surendra Tiwari
               9.6. dlg.dlg_list_ctx
               9.7. dlg.terminate_dlg
               9.8. dlg.end_dlg
-              9.9. dlg.profile_get_size
-              9.10. dlg.profile_list
-              9.11. dlg.bridge_dlg
-              9.12. dlg.stats_active
-              9.13. dlg.is_alive
+              9.9. dlg.kill_active_dlg
+              9.10. dlg.profile_get_size
+              9.11. dlg.profile_list
+              9.12. dlg.bridge_dlg
+              9.13. dlg.stats_active
+              9.14. dlg.is_alive
 
         10. Exported Variables
 
@@ -385,11 +390,12 @@ Chapter 1. Admin Guide
         9.6. dlg.dlg_list_ctx
         9.7. dlg.terminate_dlg
         9.8. dlg.end_dlg
-        9.9. dlg.profile_get_size
-        9.10. dlg.profile_list
-        9.11. dlg.bridge_dlg
-        9.12. dlg.stats_active
-        9.13. dlg.is_alive
+        9.9. dlg.kill_active_dlg
+        9.10. dlg.profile_get_size
+        9.11. dlg.profile_list
+        9.12. dlg.bridge_dlg
+        9.13. dlg.stats_active
+        9.14. dlg.is_alive
 
    10. Exported Variables
 
@@ -1906,11 +1912,12 @@ if(has_totag()) {
    9.6. dlg.dlg_list_ctx
    9.7. dlg.terminate_dlg
    9.8. dlg.end_dlg
-   9.9. dlg.profile_get_size
-   9.10. dlg.profile_list
-   9.11. dlg.bridge_dlg
-   9.12. dlg.stats_active
-   9.13. dlg.is_alive
+   9.9. dlg.kill_active_dlg
+   9.10. dlg.profile_get_size
+   9.11. dlg.profile_list
+   9.12. dlg.bridge_dlg
+   9.13. dlg.stats_active
+   9.14. dlg.is_alive
 
 9.1. dlg.list
 
@@ -2046,7 +2053,32 @@ kamcmd dlg.list_ctx [email protected]
 kamcmd dlg.end_dlg 342 56
 ...
 
-9.9. dlg.profile_get_size
+9.9. dlg.kill_active_dlg
+
+   Kills a given active dialog matching the dialog on Call-ID, From-Tag
+   and To-Tag.
+
+   Name: dlg.kill_active_dlg
+
+   Parameters:
+     * callid - Call-ID of active dialog to kill
+     * from_tag - From-Tag of active dialog to kill
+     * to_tag - To-tag of active dialog to kill
+
+   This command only handles active dialogs (state 4), error is returned
+   otherwise. Please be careful with it, it callously wipes out the given
+   dialog: dialog ending functions will not be called, such as accounting
+   end-of-call events, dialog-end events, module-generated BYE requests,
+   etc. After executing the command, dialog remains in memory until
+   execution of the recurring function in charge of removing old dialogs
+   (a "dialog in delete state is too old" will then be logged).
+
+   RPC Command Format:
+...
+kamcmd dlg.kill_active_dlg callid12345 fromtag123 totag123
+...
+
+9.10. dlg.profile_get_size
 
    Returns the number of dialogs belonging to a profile. If the profile
    supports values, the check can be reinforced to take into account a
@@ -2066,7 +2098,7 @@ kamcmd dlg.end_dlg 342 56
 kamcmd dlg.dlg.profile_get_size inbound_calls
 ...
 
-9.10. dlg.profile_list
+9.11. dlg.profile_list
 
    Lists all the dialogs belonging to a profile. If the profile supports
    values, the check can be reinforced to take into account a specific
@@ -2086,7 +2118,7 @@ kamcmd dlg.dlg.profile_get_size inbound_calls
 kamcmd dlg.profile_list inbound_calls
 ...
 
-9.11. dlg.bridge_dlg
+9.12. dlg.bridge_dlg
 
    Bridge two SIP addresses into a call using INVITE(hold)-REFER-BYE
    mechanism.
@@ -2111,7 +2143,7 @@ kamcmd dlg.profile_list inbound_calls
 kamcmd dlg.bridge_dlg _from_ _to_ _op_
 ...
 
-9.12. dlg.stats_active
+9.13. dlg.stats_active
 
    Get stats about active dialogs by scanning internal list of dialogs
    (not relying on core stats framework).
@@ -2135,7 +2167,7 @@ kamcmd dlg.bridge_dlg _from_ _to_ _op_
 kamcmd dlg.stats_active
 ...
 
-9.13. dlg.is_alive
+9.14. dlg.is_alive
 
    Check whether a dialog matching the parameter is in confirmed state
    (answered and alive).