[sr-dev] git:master:71d72bfe: modules: readme files regenerated - dialog ... [skip ci]

Module: kamailio Branch: master Commit: 71d72bfec8fad009957c1ef1e53356ba60e48669 URL: https://github.com/kamailio/kamailio/commit/71d72bfec8fad009957c1ef1e53356b… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2019-10-30T13:46:11+01:00 modules: readme files regenerated - dialog ... [skip ci] --- Modified: src/modules/dialog/README --- Diff: https://github.com/kamailio/kamailio/commit/71d72bfec8fad009957c1ef1e53356b… Patch: https://github.com/kamailio/kamailio/commit/71d72bfec8fad009957c1ef1e53356b… --- diff --git a/src/modules/dialog/README b/src/modules/dialog/README index 5dff647ef7..3b9d71b959 100644 --- a/src/modules/dialog/README +++ b/src/modules/dialog/README @@ -154,7 +154,7 @@ Julien Klingenmeyer 9.6. dlg.dlg_list_ctx 9.7. dlg.terminate_dlg 9.8. dlg.end_dlg - 9.9. dlg.kill_active_dlg + 9.9. dlg.set_state 9.10. dlg.profile_get_size 9.11. dlg.profile_list 9.12. dlg.bridge_dlg @@ -390,7 +390,7 @@ Chapter 1. Admin Guide 9.6. dlg.dlg_list_ctx 9.7. dlg.terminate_dlg 9.8. dlg.end_dlg - 9.9. dlg.kill_active_dlg + 9.9. dlg.set_state 9.10. dlg.profile_get_size 9.11. dlg.profile_list 9.12. dlg.bridge_dlg @@ -1912,7 +1912,7 @@ if(has_totag()) { 9.6. dlg.dlg_list_ctx 9.7. dlg.terminate_dlg 9.8. dlg.end_dlg - 9.9. dlg.kill_active_dlg + 9.9. dlg.set_state 9.10. dlg.profile_get_size 9.11. dlg.profile_list 9.12. dlg.bridge_dlg @@ -2053,10 +2053,10 @@ kamcmd dlg.list_ctx abcdrssfrs122444(a)192.168.1.1 kamcmd dlg.end_dlg 342 56 ... -9.9. dlg.kill_active_dlg +9.9. dlg.set_state - Kills a given active dialog matching the dialog on Call-ID, From-Tag - and To-Tag. + Set state for the dialog matching the dialog on Call-ID, From-Tag and + To-Tag. Name: dlg.kill_active_dlg @@ -2064,18 +2064,21 @@ kamcmd dlg.end_dlg 342 56 * 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). + * state - The value for new state + + At this moment, the command targets the need to change from active + dialogs (state 4) to terminated state (5), although it allows setting + other state value. Be careful using with it, it can cause side effects + and the terminated dialog is wiped out silently. Dialog ending + functions are not executed, 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 +kamcmd dlg.set_state callid12345 fromtag123 totag123 5 ... 9.10. dlg.profile_get_size